TransmissionLineCollection

A collection of transmission line results.

Example

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


transmissionLineCollection = app.Models[1].Configurations[1].TransmissionLines
   
    -- Add traces for all transmission lines in the 'TransmissionLineCollection'

graph = app.CartesianGraphs:Add()
for index, data in pairs(transmissionLineCollection) do
    graph.Traces:Add(data)
end

Usage locations

The TransmissionLineCollection object can be accessed from the following locations:

Property List

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

Property Details

Count
The number of TransmissionLineData 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 TransmissionLineData.
Return
boolean
The success of the check.
Item (index number)
Returns the TransmissionLineData at the given index.
Input Parameters
index(number)
The index of the TransmissionLineData.
Return
TransmissionLineData
The TransmissionLineData at the given index.
Item (label string)
Returns the TransmissionLineData with the given label.
Input Parameters
label(string)
The label of the TransmissionLineData.
Return
TransmissionLineData
The TransmissionLineData with the given label.
Items ()
Returns a table of TransmissionLineData.
Return
List of TransmissionLineData
A table of TransmissionLineData.
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 TransmissionLineData.