# FarFieldOptimisationGoal

A far field optimisation goal.

## Example

application = cf.Application.GetInstance()
farField = project.Contents.SolutionConfigurations[1].FarFields[1]

-- Create a far field optimisation goal with focus on the far field request

properties = cf.FarFieldOptimisationGoal.GetDefaultProperties()
properties.FocusSource = farField
properties.GoalOperator = cf.Enums.OptimisationGoalOperatorEnum.Maximise
properties.ProcessingSteps[1].Operation = cf.Enums.OptimisationGoalProcessingStepsEnum.Average

-- Set the polarisation type to Horizontal

properties = farFieldGoal:GetProperties()
properties.PolarisationType = cf.Enums.OptimisationFarFieldPolarisationTypeEnum.Horizontal
properties.ProcessingSteps[1].Operation = cf.Enums.OptimisationGoalProcessingStepsEnum.Real
farFieldGoal:SetProperties(properties)

## Inheritance

The FarFieldOptimisationGoal object is derived from the OptimisationGoal object.

## Usage locations

The FarFieldOptimisationGoal object can be accessed from the following locations:

## Property List

FocusSource
Set the focus source to a specified source object. The intended usage is for when the source is defined in CADFEKO. (Read/Write FarField)
FocusSourceLabel
Set the source focus label. The intended usage is for when the source is defined only in EDITFEKO. (Read/Write string)
FocusType
Sets the focus type. (Read/Write OptimisationFarFieldFocusTypeEnum)
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)
PolarisationType
ProcessingSteps
A number of conversion steps or mathematical operations to be carried out on the goal focus before the goal is evaluated. (Read/Write OptimisationGoalProcessingStepsList)
Type
The object type string. (Read only string)
Weight
Specify the optimisation weight. (Read/Write ParametricExpression)

## 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

FocusSource
Set the focus source to a specified source object. The intended usage is for when the source is defined in CADFEKO.
Type
FarField
Access
FocusSourceLabel
Set the source focus label. The intended usage is for when the source is defined only in EDITFEKO.
Type
string
Access
FocusType
Sets the focus type.
Type
OptimisationFarFieldFocusTypeEnum
Access
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
PolarisationType
Sets the polarisation.
Type
OptimisationFarFieldPolarisationTypeEnum
Access
ProcessingSteps
A number of conversion steps or mathematical operations to be carried out on the goal focus before the goal is evaluated.
Type
OptimisationGoalProcessingStepsList
Access
Type
The object type string.
Type
string
Access
Weight
Specify the optimisation weight.
Type
ParametricExpression
Access

## 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.