`TransmissionReflectionCollection`

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

Example

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

    -- Use the TransmissionReflectionCollection to create TransmissionReflection requests

transmissionReflectionCollection = project.Contents.SolutionConfigurations[1].TransmissionReflection
transmissionReflectionCollection:Add(0,0,0)

    -- Retrieve and delete the TransmissionReflection request

transmissionReflectionCollection:Item(1):Delete()

Inheritance

The TransmissionReflectionCollection object is derived from the Object object.

Usage locations

The TransmissionReflectionCollection object can be accessed from the following locations:

Collection lists
- StandardConfiguration object has collection TransmissionReflection.

Property List

Count: The number of TransmissionReflection 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 (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.)
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 TransmissionReflection for the given index in the collection. (Returns a TransmissionReflection object.)
Item (label string): Returns the TransmissionReflection for the given label in the collection. (Returns a TransmissionReflection object.)
Items (): Returns a table of TransmissionReflection items. (Returns a UnsupportedType(List of TransmissionReflection) 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

Count

The number of TransmissionReflection 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 (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 item.

Return

boolean: The success of the check.

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

Input Parameters

index(number): The index of the TransmissionReflection.

Return

TransmissionReflection: The item in the collection

Item (label string)

Returns the TransmissionReflection for the given label in the collection.

Input Parameters

label(string): The label of the TransmissionReflection.

Return

TransmissionReflection: The item in the collection

Items ()

Returns a table of TransmissionReflection items.

Return

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

Input Parameters

label(string): The base name.

Return

string: The generated unique name label for the item.

Static Function Details

GetDefaultProperties ()

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

Return

table: A table containing the default properties.