SARCollection
A collection of SAR calculation requests for this solution configuration.
Example
application = cf.Application.GetInstance() project = application:NewProject() -- Add a SAR request to the SAR collection configuration = project.Contents.SolutionConfigurations[1] SARCollection = configuration.SAR SARRequest = SARCollection:Add() -- Remove the SAR request from the SAR collection SARCollection:Item(SARRequest.Label):Delete()
Inheritance
The SARCollection object is derived from the Object object.
Usage locations
The SARCollection object can be accessed from the following locations:
- Collection lists
- StandardConfiguration object has collection SAR.
Property List
Method List
- Add ()
- Create a SAR calculation request. (Returns a SAR object.)
- Add (properties table)
- Create a SAR calculation request using the table of properties. (Returns a SAR 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 SAR for the given index in the collection. (Returns a SAR object.)
- Item (label string)
- Returns the SAR for the given label in the collection. (Returns a SAR object.)
- Items ()
- Returns a table of SAR items. (Returns a UnsupportedType(List of SAR) 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 ()
- Create a SAR calculation request.
- Return
- SAR
- The SAR request.
- Add (properties table)
- Create a SAR calculation request using the table of properties.
- 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 SAR for the given index in the collection.
- Item (label string)
- Returns the SAR for the given label in the collection.
- Items ()
- Returns a table of SAR items.
- Return
- UnsupportedType(List of SAR)
- 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.