API for Variables¶

Part of the Object based program API.

class VariableApi¶

Returned by

• PackageApi.VariableApi

CreateBooleanVariable(name)¶

Creates a new boolean variable.

Parameters:

name : str¶

Variable name

Returns:

New boolean variable

Return type:

BooleanVariable

CreateDynamicEnumVariable(name)¶

Creates a new Enum variable with dynamic entries.

Parameters:

name : str¶

Variable name

Returns:

New dynamic enum variable

Return type:

DynamicEnumVariable

CreateDynamicTextTableVariable(name)¶

Creates a new Texttable variable with dynamic text entries.

Parameters:

name : str¶

Variable name

Returns:

New Texttable variable

Return type:

DynamicTextTableVariable

CreateEnumVariable(name)¶

Creates a new Enum variable.

Parameters:

name : str¶

Variable name

Returns:

New Enum variable

Return type:

EnumVariable

CreateFunctionVariable(name)¶

Creates a new function variable.

Parameters:

name : str¶

Variable name

Returns:

New function variable

Return type:

FunctionVariable

CreateInboxVariable(name)¶

Creates a new Inbox variable.

Parameters:

name : str¶

Variable name

Returns:

New Inbox variable

Return type:

InboxVariable

CreateNumericVariable(name)¶

Creates a new numeric variable.

Parameters:

name : str¶

Variable name

Returns:

New numeric variable

Return type:

NumericVariable

CreateOutboxVariable(name)¶

Creates a new Outbox variable.

Parameters:

name : str¶

Variable name

Returns:

New Outbox variable

Return type:

OutboxVariable

CreatePyObjectVariable(name)¶

Creates a new PyObject variable.

Parameters:

name : str¶

Variable name

Returns:

New PyObject variable

Return type:

PyObjectVariable

CreateRelayVariable(name)¶

Creates a new Releay variable.

Parameters:

name : str¶

Variable name

Returns:

New Relay variable

Return type:

RelayVariable

CreateStaticTextTableVariable(name)¶

Creates a new Texttable variable with static text entries.

Parameters:

name : str¶

Variable name

Returns:

New Texttable variable

Return type:

StaticTextTableVariable

CreateStringVariable(name)¶

Creates a new string variable.

Parameters:

name : str¶

Variable name

Returns:

New string variable

Return type:

StringVariable

CreateStructureVariable(name)¶

Creates a new Structure variable.

Parameters:

name : str¶

Variable name

Returns:

New Structure variable

Return type:

StructureVariable

CreateVariable(name)¶

Creates a new <Undefined> variable.

Parameters:

name : str¶

Variable name

Returns:

New variable

Return type:

Variable

CreateVectorVariable(name, length=1)¶

Creates a new Vector variable.

Parameters:

name : str¶

Variable name

length : int¶

The maximum length of the Vector

Returns:

A new Vector variable

Return type:

VectorVariable