OptimisationParameters
An optimisation parameters object that defines the variables which may be used during the optimisation process.
Example
app = cf.GetApplication() project = app: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
Usage locations (object properties)
The following objects have properties using the OptimisationParameters object:
Property List
Collection List
- Constraints
- Optimisation variable constraints. (OptimisationConstraintCollection of OptimisationConstraint.)
- Variables
- Optimisation variables. (OptimisationVariableCollection of OptimisationVariable.)
Method List
- 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 table)
- 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
- Type
- The object type string.
- Type
- string
- Access
- Read only
Collection Details
- Constraints
- Optimisation variable constraints.
- Variables
- Optimisation variables.
Method Details
- 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 properties table.
- SetProperties (properties table)
- 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(table)
- 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
- The default properties table.