TransmissionReflectionOptimisationGoal
A transmission / reflection optimisation goal.
Example
application = cf.Application.GetInstance() project = application:NewProject() search = project.Optimisation.Searches:Add(cf.Enums.OptimisationMethodTypeEnum.GridSearch) -- Create a transmission reflection optimisation goal properties = cf.TransmissionReflectionOptimisationGoal.GetDefaultProperties() properties.FocusSourceLabel = "TXCoefficient" properties.FocusSourceType = cf.Enums.OptimisationFocusSourceTypeEnum.FocusSourceByLabel properties.GoalOperator = cf.Enums.OptimisationGoalOperatorEnum.Minimise properties.ProcessingSteps[1].Operation = cf.Enums.OptimisationGoalProcessingStepsEnum.Magnitude txReflectionGoal = search.Goals:AddTransmissionReflectionGoal(properties) -- Set the polarisation type to CrossPolarisation txReflectionGoal.PolarisationType = cf.Enums.OptimisationTransmissionReflectionPolarisationTypeEnum.CrossPolarisation
Inheritance
The TransmissionReflectionOptimisationGoal object is derived from the OptimisationGoal object.
Usage locations
The TransmissionReflectionOptimisationGoal object can be accessed from the following locations:
- Methods
- OptimisationGoalCollection collection has method AddTransmissionReflectionGoal(table).
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 TransmissionReflection)
- FocusSourceLabel
- Set the source focus label. The intended usage is for when the source is defined only in EDITFEKO. (Read/Write string)
- FocusType
- Sets the focus type. (Read/Write OptimisationTransmissionReflectionFocusTypeEnum)
- GoalOperator
- The goal operator indicates the desired relationship between the goal focus and the objective. (Read/Write OptimisationGoalOperatorEnum)
- Label
- The object label. (Read/Write string)
- Objective
- The objective describes a state that the optimisation process should attempt to achieve. (Read only OptimisationGoalObjective)
- PolarisationType
- Sets the polarisation. (Read/Write OptimisationTransmissionReflectionPolarisationTypeEnum)
- ProcessingSteps
- A number of conversion steps or mathematical operations to be carried out on the goal focus before the goal is evaluated. (Read/Write OptimisationGoalProcessingStepsList)
- Type
- The object type string. (Read only string)
- Weight
- Specify the optimisation weight. (Read/Write ParametricExpression)
Method List
- 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.)
- 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.
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
- TransmissionReflection
- 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
- FocusType
- Sets the focus type.
- Type
- OptimisationTransmissionReflectionFocusTypeEnum
- Access
- Read/Write
- GoalOperator
- The goal operator indicates the desired relationship between the goal focus and the objective.
- Type
- OptimisationGoalOperatorEnum
- 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
- PolarisationType
- Sets the polarisation.
- Type
- OptimisationTransmissionReflectionPolarisationTypeEnum
- Access
- Read/Write
- ProcessingSteps
- A number of conversion steps or mathematical operations to be carried out on the goal focus before the goal is evaluated.
- Type
- OptimisationGoalProcessingStepsList
- Access
- Read/Write
- Type
- The object type string.
- Type
- string
- Access
- Read only
- Weight
- Specify the optimisation weight.
- Type
- ParametricExpression
- Access
- Read/Write
Method Details
- 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.
- 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.
Static Function Details
- GetDefaultProperties ()
- Creates a table containing the default settings to create an object.
- Return
- table
- A table containing the default properties.