OptimisationSearchCollection

A collection of optimisation searches.

Example

app = cf.GetApplication()
project = app:NewProject()

    -- Add an optimisation using the grid search algorithm

project.Optimisation.Searches:Add(cf.Enums.OptimisationMethodTypeEnum.GridSearch)

    -- Check if the collection of searches contains one labelled "Search1"
    
containsSearch = project.Optimisation.Searches:Contains("Search1")

Usage locations (collections)

The following objects contain the OptimisationSearchCollection collection:

Property List

Count
The number of OptimisationSearch items in the collection. (Read only number)
Type
The object type string. (Read only string)

Method List

Add (properties table)
Create an optimisation search. (Returns a OptimisationSearch object.)
Add (method OptimisationMethodTypeEnum)
Create an optimisation search as specified by the optimisation method. (Returns a OptimisationSearch object.)
Contains (label string)
Checks if the collection contains an item with the given label. (Returns a boolean object.)
Item (index number)
Returns the OptimisationSearch at the given index. (Returns a OptimisationSearch object.)
Item (label string)
Returns the OptimisationSearch with the given label. (Returns a OptimisationSearch object.)
Items ()
Returns a table of OptimisationSearch. (Returns a List of OptimisationSearch object.)
UniqueName (label string)
Generates a unique name base of of the provided base name.If the base name already exists in the collection, a digit will be appended until a valid name is generated. (Returns a boolean object.)

Index List

[number]
Returns the OptimisationSearch at the given index in the collection. (Read OptimisationSearch)
[string]
Returns the OptimisationSearch with the given name in the collection. (Read OptimisationSearch)

Property Details

Count
The number of OptimisationSearch items in the collection.
Type
number
Access
Read only
Type
The object type string.
Type
string
Access
Read only

Method Details

Add (properties table)
Create an optimisation search.
Input Parameters
properties(table)
A table of properties defining the optimisation search.
Return
OptimisationSearch
An optimisation search.
Add (method OptimisationMethodTypeEnum)
Create an optimisation search as specified by the optimisation method.
Input Parameters
method(OptimisationMethodTypeEnum)
Optimisation method.
Return
OptimisationSearch
An optimisation search.
Contains (label string)
Checks if the collection contains an item with the given label.
Input Parameters
label(string)
The label of the OptimisationSearch.
Return
boolean
The success of the check.
Item (index number)
Returns the OptimisationSearch at the given index.
Input Parameters
index(number)
The index of the OptimisationSearch.
Return
OptimisationSearch
The OptimisationSearch at the given index.
Item (label string)
Returns the OptimisationSearch with the given label.
Input Parameters
label(string)
The label of the OptimisationSearch.
Return
OptimisationSearch
The OptimisationSearch with the given label.
Items ()
Returns a table of OptimisationSearch.
Return
List of OptimisationSearch
A table of OptimisationSearch.
UniqueName (label string)
Generates a unique name base of of the provided base name.If the base name already exists in the collection, a digit will be appended until a valid name is generated.
Input Parameters
label(string)
The base name.
Return
boolean
The generated unique name label for OptimisationSearch.