SARCollection

A collection of SAR calculation requests for this solution configuration.

Example

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

    -- Add a SAR request to the SAR collection
    
configuration = project.SolutionConfigurations[1]
SARCollection = configuration.SAR
SARRequest = SARCollection:Add()

    -- Remove the SAR request from the SAR collection
    
SARCollection:Item(SARRequest.Label):Delete()

Usage locations (collections)

The following objects contain the SARCollection collection:

Property List

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

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.)
Item (index number)
Returns the SAR at the given index. (Returns a SAR object.)
Item (label string)
Returns the SAR with the given label. (Returns a SAR object.)
Items ()
Returns a table of SAR. (Returns a List of SAR 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 SAR at the given index in the collection. (Read SAR)
[string]
Returns the SAR with the given name in the collection. (Read SAR)

Property Details

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

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.
Input Parameters
properties(table)
The table of properties.
Return
SAR
The SAR request.
Contains (label string)
Checks if the collection contains an item with the given label.
Input Parameters
label(string)
The label of the SAR.
Return
boolean
The success of the check.
Item (index number)
Returns the SAR at the given index.
Input Parameters
index(number)
The index of the SAR.
Return
SAR
The SAR at the given index.
Item (label string)
Returns the SAR with the given label.
Input Parameters
label(string)
The label of the SAR.
Return
SAR
The SAR with the given label.
Items ()
Returns a table of SAR.
Return
List of SAR
A table of SAR.
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 SAR.