OptimisationGoalObjective
The optimisation goal objective.
Example
application = cf.Application.getInstance() project = application:Load({FEKO_HOME..[[/shared/Resources/Automation/Dipole_Optimisation.cfx]]}) goal = project.Optimisation.Searches["Search1"].Goals["FarFieldGoal1"] -- Set the goal to have an objective target value less than 10 properties = goal:GetProperties() properties.GoalOperator = cf.Enums.OptimisationGoalOperatorEnum.LessThan properties.Objective.TargetValue = "10" goal:SetProperties(properties)
Inheritance
The OptimisationGoalObjective object is derived from the Object object.
Usage locations
The OptimisationGoalObjective object can be accessed from the following locations:
- Properties
- OptimisationGoal object has property Objective.
- SParameterOptimisationGoal object has property Objective.
- FarFieldOptimisationGoal object has property Objective.
- ImpedanceOptimisationGoal object has property Objective.
- NearFieldOptimisationGoal object has property Objective.
- PowerOptimisationGoal object has property Objective.
- ReceivingAntennaOptimisationGoal object has property Objective.
- SAROptimisationGoal object has property Objective.
- TransmissionReflectionOptimisationGoal object has property Objective.
Property List
- Label
- The object label. (Read/Write string)
- Mask
- Set the mask. (Read/Write OptimisationMask)
- TargetValue
- Specify the target value. (Read/Write ParametricExpression)
- TargetValueType
- Set the target value type. (Read/Write OptimisationTargetValueTypeEnum)
- Type
- The object type string. (Read only string)
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
- Mask
- Set the mask.
- Type
- OptimisationMask
- Access
- Read/Write
- TargetValue
- Specify the target value.
- Type
- ParametricExpression
- Access
- Read/Write
- TargetValueType
- Set the target value type.
- Type
- OptimisationTargetValueTypeEnum
- Access
- Read/Write
- Type
- The object type string.
- Type
- string
- Access
- Read only
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.