`VariableGroup`

A group of variables and variable groups.

Example

application = cf.Application.GetInstance()
project = application:NewProject()
    
    -- List all predefined variables in the application with their expressions

for key,var in pairs(project.Definitions.Variables) do
print(tostring(var).." = "..var.Expression)
end

Inheritance

The VariableGroup object is derived from the AbstractModifiableCollection object.

Usage locations

The VariableGroup object can be accessed from the following locations:

Methods
- VariableGroupCollection collection has method Item(number).
- VariableGroupCollection collection has method Item(string).

Property List

Count: The number of Variable items in the collection. (Read only number)
Label: The object label. (Read/Write string)
Type: The object type string. (Read only string)

Property List (internal only)

Path: (Read only string)

Collection List (internal only)

Groups: (VariableGroupCollection of VariableGroup.)

Method List

Delete (): Deletes the entity.
Duplicate (): Duplicates the entity. (Returns a Object object.)
GetProperties (): Returns a table of properties representing the state of the object. The properties table can be used with the SetProperties method to change multiple properties of the object in one step. (Returns a table object.)
Item (index number): Returns the Variable for the given index in the collection. (Returns a Variable object.)
Item (label string): Returns the Variable for the given label in the collection. (Returns a Variable object.)
Items (): Returns a table of Variable items. (Returns a UnsupportedType(List of Variable) object.)
MoveOut (entities List of Object): Move the group out of the current group and add it to its parent.
SetProperties (properties Object): Modifies the state of the object using the provided table of properties. This method is used to modify multiple properties of the object in a single step.

Method List (internal only)

CreateGroup (): (Returns a Object object.)
DeleteEntities ( List of Object)
Disassemble ()
DuplicateEntities ( List of Object): (Returns a List of Object object.)
MoveIn ( List of Object)
Replace ( Variable, Variable)

Static Function List

GetDefaultProperties (): Creates a table containing the default settings to create an object. (Returns a table object.)

Property Details

Count

The number of Variable items in the collection.

Type: number
Access: Read only

Label

The object label.

Type: string
Access: Read/Write

Type

The object type string.

Type: string
Access: Read only

Property Details (internal only)

Path

Type: string
Access: Read only

Collection Details (internal only)

Groups

Type: VariableGroupCollection

Method Details

Delete ()

Deletes the entity.

Duplicate ()

Duplicates the entity.

Return

Object: The new (duplicated) entity.

GetProperties ()

Returns a table of properties representing the state of the object. The properties table can be used with the SetProperties method to change multiple properties of the object in one step.

Return

table: A table defining the properties.

Item (index number)

Returns the Variable for the given index in the collection.

Input Parameters

index(number): The index of the Variable.

Return

Variable: The item in the collection

Item (label string)

Returns the Variable for the given label in the collection.

Input Parameters

label(string): The label of the Variable.

Return

Variable: The item in the collection

Items ()

Returns a table of Variable items.

Return

UnsupportedType(List of Variable): The list of items in the collection

MoveOut (entities List of Object)

Move the group out of the current group and add it to its parent.

Input Parameters

entities(List of Object): List of entities to be moved out.

SetProperties (properties Object)

Modifies the state of the object using the provided table of properties. This method is used to modify multiple properties of the object in a single step.

Input Parameters