OptimisationCombinationCollection

A collection of optimisation combination operators.

Example

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

    -- Combine the FarField and ImpedanceGoals.
    
optimisationSearch = project.Optimisation.Searches["Search1"]

farFieldGoal1 = optimisationSearch.Goals["FarFieldGoal1"]
impedanceGoal1 = optimisationSearch.Goals["ImpedanceGoal1"]

properties = cf.OptimisationCombination.GetDefaultProperties()
properties.Label = "Combination1"
properties.CombineType = cf.Enums.OptimisationCombineTypeEnum.Average
combination = optimisationSearch.Goals:AddCombinedGoal(properties, {farFieldGoal1, impedanceGoal1})

    -- Change the weighting of the impedance goal in the combination collection
    
combination.Goals["ImpedanceGoal1"].Weight = 5.0

Usage locations (collections)

The following objects contain the OptimisationCombinationCollection 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

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

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.