ProcessingStepsCollection

A collection of operation steps on the optimisation focus equation.

Example

app = cf.GetApplication()
project = app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/Dipole_Optimisation.cfx]])
goal = project.Optimisation.Searches["Search1"].Goals["FarFieldGoal1"]

    -- Get the number of processing step in the collection

count = goal.ProcessingSteps.Count

    -- Modify the last processing step to use the average operation
    
goal.ProcessingSteps:Modify(count, cf.Enums.OptimisationGoalProcessingStepsEnum.Average)

Usage locations (collections)

The following objects contain the ProcessingStepsCollection collection:

Property List

Count
The number of OptimisationGoalProcessingSteps items in the collection. (Read only number)

Method List

Add (enum OptimisationGoalProcessingStepsEnum)
Add a processing operation.
Add (enum OptimisationGoalProcessingStepsEnum, value Expression)
Add a processing operation.
Item (index number)
Returns the OptimisationGoalProcessingSteps at the given index. (Returns a OptimisationGoalProcessingSteps object.)
Modify (index number, enum OptimisationGoalProcessingStepsEnum)
Modify a processing step.
Modify (index number, enum OptimisationGoalProcessingStepsEnum, value Expression)
Modify a processing step.
Remove (index number)
Removes a processing operation.

Index List

[number]
Returns the OptimisationGoalProcessingSteps at the given index in the collection. (Read OptimisationGoalProcessingSteps)

Property Details

Count
The number of OptimisationGoalProcessingSteps items in the collection.
Type
number
Access
Read only

Method Details

Add (enum OptimisationGoalProcessingStepsEnum)
Add a processing operation.
Input Parameters
enum(OptimisationGoalProcessingStepsEnum)
The operator type.
Add (enum OptimisationGoalProcessingStepsEnum, value Expression)
Add a processing operation.
Input Parameters
enum(OptimisationGoalProcessingStepsEnum)
The operator type.
value(Expression)
The value used in the operation.
Item (index number)
Returns the OptimisationGoalProcessingSteps at the given index.
Input Parameters
index(number)
The index of the OptimisationGoalProcessingSteps.
Return
OptimisationGoalProcessingSteps
The OptimisationGoalProcessingSteps at the given index.
Modify (index number, enum OptimisationGoalProcessingStepsEnum)
Modify a processing step.
Input Parameters
index(number)
Index of processing step.
enum(OptimisationGoalProcessingStepsEnum)
The operator type.
Modify (index number, enum OptimisationGoalProcessingStepsEnum, value Expression)
Modify a processing step.
Input Parameters
index(number)
Index of processing step.
enum(OptimisationGoalProcessingStepsEnum)
The operator type.
value(Expression)
The value used in the operation.
Remove (index number)
Removes a processing operation.
Input Parameters
index(number)
Index of processing step.