OptimisationVariable
Variable.
Example
application = cf.Application.getInstance() project = application:NewProject() -- Add an optimisation search with the frequency as parameter freq = project.Definitions.Variables:Add("freq", 10e6) search = project.Optimisation.Searches:Add(cf.Enums.OptimisationMethodTypeEnum.GridSearch) searchVar = search.Parameters.Variables:append() searchVar.Variable = freq searchVar.MinimumValue = 1e6 searchVar.MaximumValue = 100e6 -- Set the start value of the frequency optimisation variable to 10e6 search.Parameters.Variables[1].MinimumValue = 10e6
Inheritance
The OptimisationVariable object is derived from the CompositeValue object.
Usage locations
The OptimisationVariable object can be accessed from the following locations:
- Methods
- OptimisationVariableList object has method Append().
- OptimisationVariableList object has method Get(number).
Property List
- Enabled
- Enables the variable for use in the optimisation. (Read/Write boolean)
- MaximumValue
- The maximum value of the variable. (Read/Write ParametricExpression)
- MinimumValue
- The minimum value of the variable. (Read/Write ParametricExpression)
- NumberOfGridPoints
- The number of grid points used. (Read/Write ParametricExpression)
- StartValue
- The start value of the variable. (Read/Write ParametricExpression)
- Variable
- Variable that will limited to a range. (Read/Write Variable)
Property Details
- Enabled
- Enables the variable for use in the optimisation.
- Type
- boolean
- Access
- Read/Write
- MaximumValue
- The maximum value of the variable.
- Type
- ParametricExpression
- Access
- Read/Write
- MinimumValue
- The minimum value of the variable.
- Type
- ParametricExpression
- Access
- Read/Write
- NumberOfGridPoints
- The number of grid points used.
- Type
- ParametricExpression
- Access
- Read/Write
- StartValue
- The start value of the variable.
- Type
- ParametricExpression
- Access
- Read/Write
- Variable
- Variable that will limited to a range.
- Type
- Variable
- Access
- Read/Write