Data provider signature info. More...

#include <AbstractDataProvider.qc.dox.h>

Public Attributes
*softlist< hash< DataProviderArgInfo > >	arg_info
	Argument info.

softlist< hash< DataProviderSignatureTypeInfo > >	args
	Argument types.

string	desc
	The description of the operation.

string	display_name
	The display name.

string	name
	The technical name or internal label used for the expression.

*string	render_template
	Any template to render the expression.

AbstractDataProviderType	return_type
	The return type.

*list< string >	return_type_arg_priority
	Return type argument priority list.

*bool	return_type_first_arg
	Use the first argument's type as the return type.

int	role = ER_All
	The expression role code / bitfield.

string	short_desc
	The short description of the operation.

int	subtype = DES_Generic
	The expression subtype.

string	symbol
	The symbol to use when rendering expressions.

int	type
	The type of expression; see DataProvider Expression Type Codes.

bool	varargs = False
	The last argument can be repeated indefinitely.

Detailed Description

Data provider signature info.

Member Data Documentation

◆ desc

string DataProvider::DataProviderExpressionInfo::desc

The description of the operation.

With markdown formatting

◆ name

string DataProvider::DataProviderExpressionInfo::name

The technical name or internal label used for the expression.

Must correspond to the key used in any expression hash

◆ render_template

*string DataProvider::DataProviderExpressionInfo::render_template

Any template to render the expression.

Placeholders are:

$symbol: the expression symbol
$arg[n]: the nth argument (0-based index), followed optionally by a dot and attribute name to access attributes of argument hashes
$args: all arguments as a comma-separated list

◆ return_type_arg_priority

*list<string> DataProvider::DataProviderExpressionInfo::return_type_arg_priority

Return type argument priority list.

A list of types that indicate the priority order when determining the final return type based on argument types; to determine the final return type, the first type in this list that matches any of the argument types is used as the return type; i.e. the earlier the type appears in this list, the higher its priority

If there are no matches, the declared return_type is used; normally "any"

This is useful for expressions that take multiple argument types and return different types depending on the argument types

Note: It is an error to set both this and return_type_first_arg to True

Since: DataProvider 3.3

◆ return_type_first_arg

*bool DataProvider::DataProviderExpressionInfo::return_type_first_arg

Use the first argument's type as the return type.

If set to True, the type of the first argument is used as the return type

Note: It is an error to set both this and return_type_arg_priority

Since: DataProvider 3.3

◆ role

int DataProvider::DataProviderExpressionInfo::role = ER_All

The expression role code / bitfield.

See also: Expression Role Codes

◆ subtype

int DataProvider::DataProviderExpressionInfo::subtype = DES_Generic

The expression subtype.

@ee DataProvider Expression Subtype Codes

Public Attributes