OptimisationSearchAdvancedSettings
The Advanced optimisation search settings.
Example
application = cf.Application.GetInstance() project = application:NewProject() -- Add an 'OptimisationSearch' search = project.Optimisation.Searches:Add(cf.Enums.OptimisationMethodTypeEnum.AutoMethod) -- Set the maximum number of solver runs to 20 search.Advanced.NumberOfRunsEnabled = true search.Advanced.NumberOfRuns = 20
Inheritance
The OptimisationSearchAdvancedSettings object is derived from the Object object.
Usage locations
The OptimisationSearchAdvancedSettings object can be accessed from the following locations:
- Properties
- OptimisationSearch object has property Advanced.
Property List
- Label
- The object label. (Read/Write string)
- NumberOfRuns
- Specify the the maximum number of solver runs. Changing this property will set NumberOfRunsEnabled to true. (Read/Write ParametricExpression)
- NumberOfRunsEnabled
- Enables maximum number of solver runs to be specified manually. (Read/Write boolean)
- RandomNumberGenerationOption
- Set the random number generation method. Only applies if the MethodType is set to ParticleSwarmOptimisation, GeneticAlgorithm or GlobalResponseSurfaceMethod. (Read/Write OptimisationRandomNumberGenerationOptionEnum)
- SeedValue
- Specify the seed value. Only applies if the RandomNumberGenerationOption is set to SpecifiedSeed. (Read/Write ParametricExpression)
- Type
- The object type string. (Read only string)
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
- Label
- The object label.
- Type
- string
- Access
- Read/Write
- NumberOfRuns
- Specify the the maximum number of solver runs. Changing this property will set NumberOfRunsEnabled to true.
- Type
- ParametricExpression
- Access
- Read/Write
- NumberOfRunsEnabled
- Enables maximum number of solver runs to be specified manually.
- Type
- boolean
- Access
- Read/Write
- RandomNumberGenerationOption
- Set the random number generation method. Only applies if the MethodType is set to ParticleSwarmOptimisation, GeneticAlgorithm or GlobalResponseSurfaceMethod.
- Type
- OptimisationRandomNumberGenerationOptionEnum
- Access
- Read/Write
- SeedValue
- Specify the seed value. Only applies if the RandomNumberGenerationOption is set to SpecifiedSeed.
- Type
- ParametricExpression
- Access
- Read/Write
- Type
- The object type string.
- Type
- string
- Access
- Read only
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.