`Optimisation`

An optimisation object.

Example

application = cf.Application.getInstance()
project = application:NewProject()

    -- Add an optimisation using the genetic search algorithm

project.Optimisation.Searches:Add(cf.Enums.OptimisationMethodTypeEnum.GeneticAlgorithm)

    -- Get the number of optimisation masks

maskCount = project.Optimisation.Masks.Count

Inheritance

The Optimisation object is derived from the Object object.

Usage locations

The Optimisation object can be accessed from the following locations:

Properties
- Model object has property Optimisation.

Property List

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

Collection List

Masks: A collection of optimisation masks. (OptimisationMaskCollection of OptimisationMask.)
Searches: A collection of optimisation searches. (OptimisationSearchCollection of OptimisationSearch.)

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

Collection Details

Masks

A collection of optimisation masks.

Type: OptimisationMaskCollection

Searches

A collection of optimisation searches.

Type: OptimisationSearchCollection

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.