# OptimisationGoal

An optimisation goal.

## Example

app = cf.GetApplication()
project = app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/Dipole_Optimisation.cfx]])

-- Increase the 'FarFieldGoal' weight to 2.0

goal = project.Optimisation.Searches["Search1"].Goals["FarFieldGoal1"]
goal.Weight = 2.0


## Inheritance

The OptimisationGoal object is derived from the OptimisationOperator object.

The following objects are derived (specialisations) from the OptimisationGoal object:

## Property List

GoalOperator
The goal operator indicates the desired relationship between the goal focus and the objective. (Read/Write OptimisationGoalOperatorEnum)
Label
Objective
The objective describes a state that the optimisation process should attempt to achieve. (Read only OptimisationGoalObjective)
Weight
Specify the optimisation weight. (Read/Write Expression)

## Collection List

ProcessingSteps
A number of conversion steps or mathematical operations to be carried out on the goal focus before the goal is evaluated. (ProcessingStepsCollection of OptimisationGoalProcessingSteps.)

## Method List

Delete ()
Deletes the goal.
Duplicate ()
Duplicates the goal. (Returns a OptimisationGoal object.)

## Property Details

GoalOperator
The goal operator indicates the desired relationship between the goal focus and the objective.
Type
OptimisationGoalOperatorEnum
Access
Label
The object label.
Type
string
Access
Objective
The objective describes a state that the optimisation process should attempt to achieve.
Type
OptimisationGoalObjective
Access
Weight
Specify the optimisation weight.
Type
Expression
Access

## Collection Details

ProcessingSteps
A number of conversion steps or mathematical operations to be carried out on the goal focus before the goal is evaluated.
Type
ProcessingStepsCollection

## Method Details

Delete ()
Deletes the goal.
Duplicate ()
Duplicates the goal.
Return
OptimisationGoal
A duplicate goal.