TRCoefficientCollection

A collection of transmission reflection coefficient results.

Example

app = pf.GetApplication()
app:NewProject()
app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/Wire_Cross_tht45_eta0.fek]])

transmissionReflectionCollection = app.Models[1].Configurations[1].TRCoefficients

    -- Add the first transmission reflection request to a Cartesian graph 
    
graph = app.CartesianGraphs:Add()

    -- Index method
    
txReflectionTrace1 = graph.Traces:Add(transmissionReflectionCollection[1])                 

    -- Name method
    
txReflectionTrace2 = graph.Traces:Add(transmissionReflectionCollection["TRCoefficients1"])

Usage locations (collections)

The following objects contain the TRCoefficientCollection collection:

Property List

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

Method List

Contains (label string)
Checks if the collection contains an item with the given label. (Returns a boolean object.)
Item (index number)
Returns the TRCoefficientData at the given index. (Returns a TRCoefficientData object.)
Item (label string)
Returns the TRCoefficientData with the given label. (Returns a TRCoefficientData object.)
Items ()
Returns a table of TRCoefficientData. (Returns a List of TRCoefficientData 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 TRCoefficientData at the given index in the collection. (Read TRCoefficientData)
[string]
Returns the TRCoefficientData with the given name in the collection. (Read TRCoefficientData)

Property Details

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

Method Details

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