OptimisationGoalCollection

A collection of optimisation operators.

Example

application = cf.Application.GetInstance()
project = application:Load({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")

Inheritance

The OptimisationGoalCollection object is derived from the Object object.

Usage locations

The OptimisationGoalCollection object can be accessed from the following locations:

Property List

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

Method List

AddCombinedGoal (properties table)
Create a combined optimisation goal. (Returns a OptimisationCombination object.)
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.)
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.)
Item (index number)
Returns the OptimisationOperator for the given index in the collection. (Returns a OptimisationOperator object.)
Item (label string)
Returns the OptimisationOperator for the given label in the collection. (Returns a OptimisationOperator object.)
Items ()
Returns a table of OptimisationOperator items. (Returns a UnsupportedType(List of OptimisationOperator) 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.
UniqueName (label string)
Generates a unique name base 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 string object.)

Static Function List

GetDefaultProperties ()
Creates a table containing the default settings to create an object. (Returns a table object.)

Property Details

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

Method Details

AddCombinedGoal (properties table)
Create a combined optimisation goal.
Input Parameters
properties(table)
A table of properties defining the combined optimisation goal.
Return
OptimisationCombination
Returns a OptimisationCombination object.
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 OptimisationOperator.
Return
OptimisationCombination
Returns a OptimisationCombination object.
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 item.
Return
boolean
The success of the check.
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.
Item (index number)
Returns the OptimisationOperator for the given index in the collection.
Input Parameters
index(number)
The index of the OptimisationOperator.
Return
OptimisationOperator
The item in the collection
Item (label string)
Returns the OptimisationOperator for the given label in the collection.
Input Parameters
label(string)
The label of the OptimisationOperator.
Return
OptimisationOperator
The item in the collection
Items ()
Returns a table of OptimisationOperator items.
Return
UnsupportedType(List of OptimisationOperator)
The list of items in the collection
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.
UniqueName (label string)
Generates a unique name base 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
string
The generated unique name label for the item.

Static Function Details

GetDefaultProperties ()
Creates a table containing the default settings to create an object.
Return
table
A table containing the default properties.