TransmissionLineTerminalCollection

A collection of transmission line port terminals.

Example

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

config = project.SolutionConfigurations[1]

    -- Create a transmission lines
    
transmissionLine = config.Networks:AddTransmissionLine(10, 50, 25, 10)

    -- Add a source to transmission line terminal

config.Sources:AddVoltageSource(transmissionLine.Terminals[1])

Usage locations (collections)

The following objects contain the TransmissionLineTerminalCollection collection:

Property List

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

Property Details

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