SParameterOptimisationGoal
An S-parameter optimisation goal.
Example
app = cf.GetApplication() project = app:NewProject() search = project.Optimisation.Searches:Add(cf.Enums.OptimisationMethodTypeEnum.GridSearch) -- Create an S-parameter optimisation goal with focus on a request with label 'SParameter' properties = cf.SParameterOptimisationGoal.GetDefaultProperties() properties.FocusSourceLabel = "SParameter" properties.GoalOperator = cf.Enums.OptimisationGoalOperatorEnum.LessThan properties.InputPort = 2 properties.Objective.TargetValue = "1.5" properties.ProcessingSteps[1].Operation = cf.Enums.OptimisationGoalProcessingStepsEnum.Magnitude sParameterGoal = search.Goals:AddSParameterGoal(properties) -- Set the output port number to 1 sParameterGoal.OutputPort = 1
Inheritance
The SParameterOptimisationGoal object is derived from the OptimisationGoal object.
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 SParameter)
- FocusSourceLabel
- Set the source focus label. The intended usage is for when the source is defined only in EDITFEKO. (Read/Write string)
- GoalOperator
- The goal operator indicates the desired relationship between the goal focus and the objective. (Read/Write OptimisationGoalOperatorEnum)
- InputPort
- Input port number (n). Changing this property will set InputPortSpecified to true. (Read/Write number)
- InputPortSpecified
- Specify input port enabled. (Read/Write boolean)
- Label
- The object label. (Read/Write string)
- Objective
- The objective describes a state that the optimisation process should attempt to achieve. (Read only OptimisationGoalObjective)
- OutputPort
- Output port number (m). Changing this property will set OutputPortSpecified to true. (Read/Write number)
- OutputPortSpecified
- Specify output port enabled. (Read/Write boolean)
- Quantity
- Set the focus type. (Read/Write OptimisationSParameterFocusTypeEnum)
- Type
- The object type string. (Read only string)
- Weight
- Specify the optimisation weight. (Read/Write Expression)
Collection List
- ProcessingSteps
- A number of conversion steps or mathematical operations to be carried out on the goal focus before the goal is evaluated. (ProcessingStepsCollection of OptimisationGoalProcessingSteps.)
Method List
- Delete ()
- Deletes the goal.
- Duplicate ()
- Duplicates the goal. (Returns a OptimisationGoal 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 table)
- 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
- SParameter
- Access
- Read/Write
- FocusSourceLabel
- Set the source focus label. The intended usage is for when the source is defined only in EDITFEKO.
- Type
- string
- Access
- Read/Write
- GoalOperator
- The goal operator indicates the desired relationship between the goal focus and the objective.
- Type
- OptimisationGoalOperatorEnum
- Access
- Read/Write
- InputPort
- Input port number (n). Changing this property will set InputPortSpecified to true.
- Type
- number
- Access
- Read/Write
- InputPortSpecified
- Specify input port enabled.
- Type
- boolean
- Access
- Read/Write
- Label
- The object label.
- Type
- string
- Access
- Read/Write
- Objective
- The objective describes a state that the optimisation process should attempt to achieve.
- Type
- OptimisationGoalObjective
- Access
- Read only
- OutputPort
- Output port number (m). Changing this property will set OutputPortSpecified to true.
- Type
- number
- Access
- Read/Write
- OutputPortSpecified
- Specify output port enabled.
- Type
- boolean
- Access
- Read/Write
- Quantity
- Set the focus type.
- Type
- OptimisationSParameterFocusTypeEnum
- Access
- Read/Write
- Type
- The object type string.
- Type
- string
- Access
- Read only
- Weight
- Specify the optimisation weight.
- Type
- Expression
- Access
- Read/Write
Collection Details
- ProcessingSteps
- A number of conversion steps or mathematical operations to be carried out on the goal focus before the goal is evaluated.
Method Details
- Delete ()
- Deletes the goal.
- Duplicate ()
- Duplicates the goal.
- Return
- OptimisationGoal
- A duplicate goal.
- 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 properties table.
- SetProperties (properties table)
- 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(table)
- 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
- The default properties table.