`ModelDecompositionCollection`

A collection of solution model decomposition for this solution configuration.

Example

application = cf.Application.getInstance()
project = application:NewProject()

    -- Add a model decomposition request to the model decomposition collection

modelDecompositionCollection = project.Contents.SolutionConfigurations[1].ModelDecompositions
modelDecompositionRequest = modelDecompositionCollection:Add()

    -- Remove the model decomposition request from the model decomposition collection

modelDecompositionCollection:Item(modelDecompositionRequest.Label):Delete()

Inheritance

The ModelDecompositionCollection object is derived from the Object object.

Usage locations

The ModelDecompositionCollection object can be accessed from the following locations:

Collection lists
- StandardConfiguration object has collection ModelDecompositions.

Property List

Count: The number of ModelDecomposition items in the collection. (Read only number)
Label: The object label. (Read/Write string)
Type: The object type string. (Read only string)

Method List

Add (properties table): Create a model decomposition calculation using the table of properties. (Returns a ModelDecomposition object.)
Add (): Request a model decomposition calculation. (Returns a ModelDecomposition object.)
Delete (): Deletes the entity.
DeleteEntities ( List of Object): Delete the given list of entities from the collection.
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 ModelDecomposition for the given index in the collection. (Returns a ModelDecomposition object.)
Item (label string): Returns the ModelDecomposition for the given label in the collection. (Returns a ModelDecomposition object.)
Items (): Returns a table of ModelDecomposition items. (Returns a UnsupportedType(List of ModelDecomposition) 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

Count

The number of ModelDecomposition items in the collection.

Type: number
Access: Read only

Label

The object label.

Type: string
Access: Read/Write

Type

The object type string.

Type: string
Access: Read only

Method Details

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.

Add ()

Request a model decomposition calculation.

Return

ModelDecomposition: The model decomposition request.

Delete ()

Deletes the entity.

DeleteEntities ( List of Object)

Delete the given list of entities from the collection.

Input Parameters

(List of Object)

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 ModelDecomposition for the given index in the collection.

Input Parameters

index(number): The index of the ModelDecomposition.

Return

ModelDecomposition: The item in the collection

Item (label string)

Returns the ModelDecomposition for the given label in the collection.

Input Parameters

label(string): The label of the ModelDecomposition.

Return

ModelDecomposition: The item in the collection

Items ()

Returns a table of ModelDecomposition items.

Return

UnsupportedType(List of ModelDecomposition): 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.

Static Function Details

GetDefaultProperties ()

Creates a table containing the default settings to create an object.

Return

table: A table containing the default properties.