OptimisationMaskCollection
A collection of optimisation masks.
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} project.Optimisation.Masks:Add(xValues, yValues) -- Check if the collection of masks contains one labelled "Mask1" hasMask = project.Optimisation.Masks:Contains("Mask1")
Inheritance
The OptimisationMaskCollection object is derived from the Object object.
Usage locations
The OptimisationMaskCollection object can be accessed from the following locations:
- Collection lists
- Optimisation object has collection Masks.
Property List
Method List
- Add (properties table)
- Create an optimisation mask. (Returns a OptimisationMask object.)
- Add (xvaluelist ExpressionList, yvaluelist ExpressionList)
- Create an optimisation mask. (Returns a OptimisationMask object.)
- Delete ()
- Deletes the entity.
- DeleteEntities ( List of Object)
- Delete the given list of entities from the collection.
- 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 OptimisationMask for the given index in the collection. (Returns a OptimisationMask object.)
- Item (label string)
- Returns the OptimisationMask for the given label in the collection. (Returns a OptimisationMask object.)
- Items ()
- Returns a table of OptimisationMask items. (Returns a UnsupportedType(List of OptimisationMask) 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
Method Details
- Add (properties table)
- Create an optimisation mask.
- Input Parameters
- properties(table)
- A table of properties defining the optimisation mask.
- Return
- OptimisationMask
- An optimisation mask.
- Add (xvaluelist ExpressionList, yvaluelist ExpressionList)
- Create an optimisation mask.
- Input Parameters
- xvaluelist(ExpressionList)
- The x values of the mask.
- yvaluelist(ExpressionList)
- The x values of the mask.
- Return
- OptimisationMask
- An optimisation mask.
- Delete ()
- Deletes the entity.
- DeleteEntities ( List of Object)
- Delete the given list of entities from the collection.
- 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 OptimisationMask for the given index in the collection.
- Input Parameters
- index(number)
- The index of the OptimisationMask.
- Return
- OptimisationMask
- The item in the collection
- Item (label string)
- Returns the OptimisationMask for the given label in the collection.
- Input Parameters
- label(string)
- The label of the OptimisationMask.
- Return
- OptimisationMask
- The item in the collection
- Items ()
- Returns a table of OptimisationMask items.
- Return
- UnsupportedType(List of OptimisationMask)
- The list of items in the collection
- 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.