TransmissionReflectionCollection

A collection of transmission / reflection coefficient calculations requests for this solution configuration.

Example

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

    -- Use the TransmissionReflectionCollection to create TransmissionReflection requests
    
transmissionReflectionCollection = project.SolutionConfigurations[1].TransmissionReflection
transmissionReflectionCollection:Add(0,0,0)

    -- Retrieve and delete the TransmissionReflection request
    
transmissionReflectionCollection:Item(1):Delete()

Usage locations (collections)

The following objects contain the TransmissionReflectionCollection collection:

Property List

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

Method List

Add (x Expression, y Expression, z Expression)
Create a transmission / reflection coefficient calculations request. (Returns a TransmissionReflection object.)
Add (properties table)
Create a transmission / reflection coefficient calculations request using the table of properties. (Returns a TransmissionReflection object.)
Contains (label string)
Checks if the collection contains an item with the given label. (Returns a boolean object.)
Item (index number)
Returns the TransmissionReflection at the given index. (Returns a TransmissionReflection object.)
Item (label string)
Returns the TransmissionReflection with the given label. (Returns a TransmissionReflection object.)
Items ()
Returns a table of TransmissionReflection. (Returns a List of TransmissionReflection 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 TransmissionReflection at the given index in the collection. (Read TransmissionReflection)
[string]
Returns the TransmissionReflection with the given name in the collection. (Read TransmissionReflection)

Property Details

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

Method Details

Add (x Expression, y Expression, z Expression)
Create a transmission / reflection coefficient calculations request.
Input Parameters
x(Expression)
The X position.
y(Expression)
The Y position.
z(Expression)
The Z position.
Return
TransmissionReflection
The transmission / reflection request.
Add (properties table)
Create a transmission / reflection coefficient calculations request using the table of properties.
Input Parameters
properties(table)
The table of properties.
Return
TransmissionReflection
The transmission / reflection request.
Contains (label string)
Checks if the collection contains an item with the given label.
Input Parameters
label(string)
The label of the TransmissionReflection.
Return
boolean
The success of the check.
Item (index number)
Returns the TransmissionReflection at the given index.
Input Parameters
index(number)
The index of the TransmissionReflection.
Return
TransmissionReflection
The TransmissionReflection at the given index.
Item (label string)
Returns the TransmissionReflection with the given label.
Input Parameters
label(string)
The label of the TransmissionReflection.
Return
TransmissionReflection
The TransmissionReflection with the given label.
Items ()
Returns a table of TransmissionReflection.
Return
List of TransmissionReflection
A table of TransmissionReflection.
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 TransmissionReflection.