OptimisationMask

An optimisation mask.

Example

app = cf.GetApplication()
project = app:NewProject()

    -- Add an optimisation mask for the given list of values

xValues = {0, 1, 2, 3, 4}
yValues = {0, 10, 20, 20, 30}
mask = project.Optimisation.Masks:Add(xValues, yValues)

    -- Set the label of the mask
    
mask.Label = "ImpedanceMask"

Usage locations (object properties)

The following objects have properties using the OptimisationMask object:

Property List

Label
The object label. (Read/Write string)
Type
The object type string. (Read only string)

Collection List

Values
Mask coordinates. (OptimisationMaskValueCollection of OptimisationMaskValues.)

Method List

Delete ()
Deletes the mask.
Duplicate ()
Duplicates the mask. (Returns a OptimisationMask 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.)
SetProperties (properties table)
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.

Static Function List

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

Property Details

Label
The object label.
Type
string
Access
Read/Write
Type
The object type string.
Type
string
Access
Read only

Collection Details

Values
Mask coordinates.
Type
OptimisationMaskValueCollection

Method Details

Delete ()
Deletes the mask.
Duplicate ()
Duplicates the mask.
Return
OptimisationMask
A duplicate mask.
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 properties table.
SetProperties (properties table)
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
properties(table)
A table of properties defining the new state of the object.

Static Function Details

GetDefaultProperties ()
Creates a table containing the default settings to create an object.
Return
table
The default properties table.