OptimisationOperator
An optimisation operator.
Example
application = cf.Application.getInstance() project = application:Load({FEKO_HOME..[[/shared/Resources/Automation/Dipole_Optimisation.cfx]]}) -- Set the label of the optimisation operator optimisationOperator = project.Optimisation.Searches["Search1"].Goals["FarFieldGoal1"] optimisationOperator.Label = "MaxFarFieldGainGoal"
Inheritance
The OptimisationOperator object is derived from the Object object.
The following objects are derived (specialisations) from the OptimisationOperator object:
Usage locations
The OptimisationOperator object can be accessed from the following locations:
- Methods
- OptimisationGoalCollection collection has method Item(number).
- OptimisationGoalCollection collection has method Item(string).
Property List
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
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.