`OptimisationMask`

An optimisation mask.

Example

application = cf.Application.GetInstance()
project = application: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"

Inheritance

The OptimisationMask object is derived from the Object object.

Usage locations

The OptimisationMask object can be accessed from the following locations:

Properties
- OptimisationGoalObjective object has property Mask.
Methods
- OptimisationMaskCollection collection has method Add(table).
- OptimisationMaskCollection collection has method Add(ExpressionList, ExpressionList).
- OptimisationMaskCollection collection has method Item(number).
- OptimisationMaskCollection collection has method Item(string).

Property List

Label: The object label. (Read/Write string)
Type: The object type string. (Read only string)
Values: Mask coordinates. (Read/Write OptimisationMaskValuesList)

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.)
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.

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

Values

Mask coordinates.

Type: OptimisationMaskValuesList
Access: Read/Write

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.

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

properties(Object): 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: A table containing the default properties.