OptimisationSearchCollection
A collection of optimisation searches.
Example
application = cf.Application.GetInstance() project = application: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")
Inheritance
The OptimisationSearchCollection object is derived from the Object object.
Usage locations
The OptimisationSearchCollection object can be accessed from the following locations:
- Collection lists
- Optimisation object has collection Searches.
Property List
Method List
- Add (table 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.)
- 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.)
- Item (index number)
- Returns the OptimisationSearch for the given index in the collection. (Returns a OptimisationSearch object.)
- Item (label string)
- Returns the OptimisationSearch for the given label in the collection. (Returns a OptimisationSearch object.)
- Items ()
- Returns a table of OptimisationSearch items. (Returns a UnsupportedType(List of OptimisationSearch) 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.
- UniqueName (label string)
- Generates a unique name base 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 string object.)
Static Function List
- GetDefaultProperties ()
- Creates a table containing the default settings to create an object. (Returns a table object.)
Property Details
Method Details
- Add (table table)
- Create an optimisation search.
- Input Parameters
- table(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.
- 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.
- Item (index number)
- Returns the OptimisationSearch for the given index in the collection.
- Input Parameters
- index(number)
- The index of the OptimisationSearch.
- Return
- OptimisationSearch
- The item in the collection
- Item (label string)
- Returns the OptimisationSearch for the given label in the collection.
- Input Parameters
- label(string)
- The label of the OptimisationSearch.
- Return
- OptimisationSearch
- The item in the collection
- Items ()
- Returns a table of OptimisationSearch items.
- Return
- UnsupportedType(List of OptimisationSearch)
- The list of items in the collection
- 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.
- UniqueName (label string)
- Generates a unique name base 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.
Static Function Details
- GetDefaultProperties ()
- Creates a table containing the default settings to create an object.
- Return
- table
- A table containing the default properties.