HxExternalArgumentValues Class¶

class HxExternalArgumentValues¶

Argument values for external functions. Argument values are used to query the values of the arguments passed to external functions.

Since:: 13.5

Summary¶

Methods¶
`count`	Returns the number of argument values.
`isUndefined`	Returns true if the argument at the given position has an undefined value.

Overloaded operators¶
`iterator`	Returns an iterator than can be used within a for statement.
`index`	Indexer.

Functions¶

HxExternalArgumentValues.count()¶

Returns the number of argument values. Arguments are indexed from 0 to count()-1.

Returns:: Number of arguments
Return type:: int

HxExternalArgumentValues.isUndefined(position)¶

Returns true if the argument at the given position has an undefined value. An undefined value is often the result of an illegal or impossible operation. For example, the square root of a negative number, the addition of 2 opposite infinities, accessing an array or collection outside its bounds…

Attempting to access an argument with an undefined value will raise an exception. It is therefore recommended to check whether or not each argument is undefined before accessing its value. This is particularly true during the feasibility phase, when the probability of incorrect operations is very high.

Parameters:: position (int) – Position of the argument to query.
Returns:: True if the argument at the given pos is undefined.
Return type:: bool

Overloaded operators¶

HxExternalArgumentValues.iterator()¶: Returns an iterator than can be used within a for statement.

HxExternalArgumentValues.index(position)¶

Indexer. Gets the value at the given position.

Parameters:: position (int) – The considered position. Must be non negative and striclty smaller than the number of arguments.
Returns:: The value at the given position