API for Expressions¶

Part of the Object based program API.

class ExpressionApi¶

Returned by

• PackageApi.ExpressionApi

CreateCurveExpression(length, defaultValue=None, distributionDefaultValue=None)¶

Creates a CurveExpression

Parameters:

length : int¶

maximum number of elements

defaultValue : str¶

Expression to be used as default value

distributionDefaultValue : str¶

Expression to be used as default value for distribution

Returns:

The curve expression

Return type:

CurveExpression

CreateKeywordValueExpression(value)¶

Creates a KeywordValue expression that uses the identifier to a localization object.

Parameters:

value : int¶

The value that refers to a localization identifier.

Returns:

The KeywordValue expression

Return type:

KeywordValueExpression

CreateMapExpression(xDimension, yDimension, defaultValue=None, xDistributionDefaultValue=None, yDistributionDefaultValue=None)¶

Creates a MapExpression

Parameters:

xDimension : int¶

maximum number of elements in x dimension

yDimension : int¶

maximum number of elements in y dimension

defaultValue : str¶

Expression to be used as default value

xDistributionDefaultValue : str¶

Expression to be used as default value for x distribution

yDistributionDefaultValue : str¶

Expression to be used as default value for y distribution

Returns:

The map expression

Return type:

MapExpression

CreateMatrixExpression(xDimension, yDimension, defaultValue=None)¶

Creates a MatrixExpression

Parameters:

xDimension : int¶

maximum number of elements in x dimension

yDimension : int¶

maximum number of elements in y dimension

defaultValue : str¶

Expression to be used as default value

Returns:

The matrix expression

Return type:

MatrixExpression

CreateVectorExpression(length, defaultValue=None)¶

Creates a VectorExpression

Parameters:

length : int¶

maximum number of elements

defaultValue : str¶

Expression to be used as default value

Returns:

The vector expression

Return type:

VectorExpression