TransmissionReflection
A transmission / reflection coefficient calculations request.
Example
application = cf.Application.GetInstance() project = application:NewProject() transmissionReflectionCollection = project.Contents.SolutionConfigurations[1].TransmissionReflection -- Create a TransmissionReflection request transmissionReflection = transmissionReflectionCollection:Add(0,0,0) -- Modify the position of the TransmissionReflection request transmissionReflection.Position = cf.Point(1,2,3) -- Delete the TransmissionReflection request transmissionReflection:Delete()
Inheritance
The TransmissionReflection object is derived from the Object object.
Usage locations
The TransmissionReflection object can be accessed from the following locations:
- Properties
- TransmissionReflectionOptimisationGoal object has property FocusSource.
- Methods
- TransmissionReflectionCollection collection has method Add(Expression, Expression, Expression).
- TransmissionReflectionCollection collection has method Add(table).
- TransmissionReflectionCollection collection has method Item(number).
- TransmissionReflectionCollection collection has method Item(string).
Property List
- ExportEnabled
- Specifies if the transmission and reflection coefficients should be exported to a file (*.tr). (Read/Write boolean)
- Included
- A boolean value defining if an entity is excluded or included. (Read/Write boolean)
- Label
- The object label. (Read/Write string)
- Position
- The plane position for the phase reference. (Read/Write GlobalCoordinates)
- Type
- The object type string. (Read only string)
Method List
- 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.)
- 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
- ExportEnabled
- Specifies if the transmission and reflection coefficients should be exported to a file (*.tr).
- Type
- boolean
- Access
- Read/Write
- Included
- A boolean value defining if an entity is excluded or included.
- Type
- boolean
- Access
- Read/Write
- Label
- The object label.
- Type
- string
- Access
- Read/Write
- Position
- The plane position for the phase reference.
- Type
- GlobalCoordinates
- Access
- Read/Write
- Type
- The object type string.
- Type
- string
- Access
- Read only
Method Details
- 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.
- 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.