ModelDecompositionCollection
A collection of solution model decomposition for this solution configuration.
Example
app = cf.GetApplication() project = app:NewProject() -- Add a model decomposition request to the model decomposition collection modelDecompositionCollection = project.SolutionConfigurations[1].ModelDecompositions modelDecompositionRequest = modelDecompositionCollection:Add() -- Remove the model decomposition request from the model decomposition collection modelDecompositionCollection:Item(modelDecompositionRequest.Label):Delete()
Usage locations (collections)
The following objects contain the ModelDecompositionCollection collection:
Property List
Method List
- Add ()
- Request a model decomposition calculation. (Returns a ModelDecomposition object.)
- Add (properties table)
- Create a model decomposition calculation using the table of properties. (Returns a ModelDecomposition object.)
- Contains (label string)
- Checks if the collection contains an item with the given label. (Returns a boolean object.)
- Item (index number)
- Returns the ModelDecomposition at the given index. (Returns a ModelDecomposition object.)
- Item (label string)
- Returns the ModelDecomposition with the given label. (Returns a ModelDecomposition object.)
- Items ()
- Returns a table of ModelDecomposition. (Returns a List of ModelDecomposition 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 ModelDecomposition at the given index in the collection. (Read ModelDecomposition)
- [string]
- Returns the ModelDecomposition with the given name in the collection. (Read ModelDecomposition)
Property Details
Method Details
- Add ()
- Request a model decomposition calculation.
- Return
- ModelDecomposition
- The model decomposition request.
- Add (properties table)
- Create a model decomposition calculation using the table of properties.
- Input Parameters
- properties(table)
- The table of properties.
- Return
- ModelDecomposition
- The model decomposition request.
- Contains (label string)
- Checks if the collection contains an item with the given label.
- Item (index number)
- Returns the ModelDecomposition at the given index.
- Input Parameters
- index(number)
- The index of the ModelDecomposition.
- Return
- ModelDecomposition
- The ModelDecomposition at the given index.
- Item (label string)
- Returns the ModelDecomposition with the given label.
- Input Parameters
- label(string)
- The label of the ModelDecomposition.
- Return
- ModelDecomposition
- The ModelDecomposition with the given label.
- Items ()
- Returns a table of ModelDecomposition.
- Return
- List of ModelDecomposition
- A table of ModelDecomposition.
- 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.