OptimisationGoalCollection

A collection of optimisation operators.

Example

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

    -- Check if the optimisation goal collection contains one with the label "FarFieldGoal1"
    
containsGoal = project.Optimisation.Searches["Search1"].Goals:Contains("FarFieldGoal1")

Usage locations (collections)

The following objects contain the OptimisationGoalCollection collection:

Property List

Count
The number of OptimisationOperator items in the collection. (Read only number)
Type
The object type string. (Read only string)

Method List

AddCombinedGoal (properties table, goals List of OptimisationOperator)
Create a combined optimisation goal. (Returns a OptimisationCombination object.)
AddFarFieldGoal (properties table)
Create a far field optimisation goal. (Returns a FarFieldOptimisationGoal object.)
AddImpedanceGoal (properties table)
Create an impedance optimisation goal. (Returns a ImpedanceOptimisationGoal object.)
AddNearFieldGoal (properties table)
Create a near field optimisation goal. (Returns a NearFieldOptimisationGoal object.)
AddPowerGoal (properties table)
Create a power optimisation goal. (Returns a PowerOptimisationGoal object.)
AddReceivingAntennaGoal (properties table)
Create a receiving antenna optimisation goal. (Returns a ReceivingAntennaOptimisationGoal object.)
AddSARGoal (properties table)
Create a SAR optimisation goal. (Returns a SAROptimisationGoal object.)
AddSParameterGoal (properties table)
Create an S-parameter optimisation goal. (Returns a SParameterOptimisationGoal object.)
AddTransmissionReflectionGoal (properties table)
Create a transmission line optimisation goal. (Returns a TransmissionReflectionOptimisationGoal object.)
Contains (label string)
Checks if the collection contains an item with the given label. (Returns a boolean object.)
Item (index number)
Returns the OptimisationOperator at the given index. (Returns a OptimisationOperator object.)
Item (label string)
Returns the OptimisationOperator with the given label. (Returns a OptimisationOperator object.)
Items ()
Returns a table of OptimisationOperator. (Returns a List of OptimisationOperator object.)
UniqueName (label string)
Generates a unique name base of of the provided base name.If the base name already exists in the collection, a digit will be appended until a valid name is generated. (Returns a boolean object.)

Index List

[number]
Returns the OptimisationOperator at the given index in the collection. (Read OptimisationOperator)
[string]
Returns the OptimisationOperator with the given name in the collection. (Read OptimisationOperator)

Property Details

Count
The number of OptimisationOperator items in the collection.
Type
number
Access
Read only
Type
The object type string.
Type
string
Access
Read only

Method Details

AddCombinedGoal (properties table, goals List of OptimisationOperator)
Create a combined optimisation goal.
Input Parameters
properties(table)
A table of properties defining the combined optimisation goal.
goals(List of OptimisationOperator)
List of goals to combine.
Return
OptimisationCombination
A combined optimisation goal.
AddFarFieldGoal (properties table)
Create a far field optimisation goal.
Input Parameters
properties(table)
A table of properties defining the far field optimisation goal.
Return
FarFieldOptimisationGoal
A far field optimisation goal.
AddImpedanceGoal (properties table)
Create an impedance optimisation goal.
Input Parameters
properties(table)
A table of properties defining the impedance optimisation goal.
Return
ImpedanceOptimisationGoal
An impedance optimisation goal.
AddNearFieldGoal (properties table)
Create a near field optimisation goal.
Input Parameters
properties(table)
A table of properties defining the near field optimisation goal.
Return
NearFieldOptimisationGoal
A near field optimisation goal.
AddPowerGoal (properties table)
Create a power optimisation goal.
Input Parameters
properties(table)
A table of properties defining the power optimisation goal.
Return
PowerOptimisationGoal
A power optimisation goal.
AddReceivingAntennaGoal (properties table)
Create a receiving antenna optimisation goal.
Input Parameters
properties(table)
A table of properties defining the receiving antenna optimisation goal.
Return
ReceivingAntennaOptimisationGoal
A receiving antenna optimisation goal.
AddSARGoal (properties table)
Create a SAR optimisation goal.
Input Parameters
properties(table)
A table of properties defining the SAR optimisation goal.
Return
SAROptimisationGoal
A SAR optimisation goal.
AddSParameterGoal (properties table)
Create an S-parameter optimisation goal.
Input Parameters
properties(table)
A table of properties defining the S-parameter optimisation goal.
Return
SParameterOptimisationGoal
An S-parameter optimisation goal.
AddTransmissionReflectionGoal (properties table)
Create a transmission line optimisation goal.
Input Parameters
properties(table)
A table of properties defining the transmission line optimisation goal.
Return
TransmissionReflectionOptimisationGoal
A transmission line optimisation goal.
Contains (label string)
Checks if the collection contains an item with the given label.
Input Parameters
label(string)
The label of the OptimisationOperator.
Return
boolean
The success of the check.
Item (index number)
Returns the OptimisationOperator at the given index.
Input Parameters
index(number)
The index of the OptimisationOperator.
Return
OptimisationOperator
The OptimisationOperator at the given index.
Item (label string)
Returns the OptimisationOperator with the given label.
Input Parameters
label(string)
The label of the OptimisationOperator.
Return
OptimisationOperator
The OptimisationOperator with the given label.
Items ()
Returns a table of OptimisationOperator.
Return
List of OptimisationOperator
A table of OptimisationOperator.
UniqueName (label string)
Generates a unique name base of of the provided base name.If the base name already exists in the collection, a digit will be appended until a valid name is generated.
Input Parameters
label(string)
The base name.
Return
boolean
The generated unique name label for OptimisationOperator.