OptimisationMaskValueCollection

A collection of mask values.

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)

    -- Modify the last Y value of the mask
    
mask.Values[#mask.Values].Y = 5

Usage locations (collections)

The following objects contain the OptimisationMaskValueCollection collection:

Property List

Count
The number of OptimisationMaskValues items in the collection. (Read only number)

Method List

Item (index number)
Returns the OptimisationMaskValues at the given index. (Returns a OptimisationMaskValues object.)

Index List

[number]
Returns the OptimisationMaskValues at the given index in the collection. (Read OptimisationMaskValues)

Property Details

Count
The number of OptimisationMaskValues items in the collection.
Type
number
Access
Read only

Method Details

Item (index number)
Returns the OptimisationMaskValues at the given index.
Input Parameters
index(number)
The index of the OptimisationMaskValues.
Return
OptimisationMaskValues
The OptimisationMaskValues at the given index.