OptimisationParameters
An optimisation parameters object that defines the variables which may be used during the optimisation process.
Example
application = cf.Application.GetInstance() project = application:NewProject() -- Add an optimisation using the grid search algorithm search = project.Optimisation.Searches:Add(cf.Enums.OptimisationMethodTypeEnum.GridSearch) -- Get the number of optimisation parameters variables defined variableCount = search.Parameters.Variables:count()
Inheritance
The OptimisationParameters object is derived from the Object object.
Usage locations
The OptimisationParameters object can be accessed from the following locations:
- Properties
- OptimisationSearch object has property Parameters.
Property List
- Constraints
- A collection of variable constraints. (Read/Write OptimisationConstraintList)
- Label
- The object label. (Read/Write string)
- Type
- The object type string. (Read only string)
- Variables
- A collection of variables used in the optimisation process. (Read/Write OptimisationVariableList)
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
- Constraints
- A collection of variable constraints.
- Type
- OptimisationConstraintList
- Access
- Read/Write
- Label
- The object label.
- Type
- string
- Access
- Read/Write
- Type
- The object type string.
- Type
- string
- Access
- Read only
- Variables
- A collection of variables used in the optimisation process.
- Type
- OptimisationVariableList
- 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.