GeneralNetworkTerminalCollection
A collection of terminals.
Example
app = cf.GetApplication() project = app:NewProject() -- Set up 2D table to use for constructing 'GeneralNetwork' real = {} imaginary = {} for n=1,2 do real[n] = {} imaginary[n] = {} for m=1,2 do real[n][m] = 50 imaginary[n][m] = 0 end end -- Create a 'GeneralNetwork' with two terminals networks = project.SolutionConfigurations["StandardConfiguration1"].Networks networks:AddGeneralNetwork(cf.Enums.GeneralNetworkDataTypeEnum.SMatrix, 2, real, imaginary) -- Get the number of terminals on the 'GeneralNetwork' object count = networks["GeneralNetwork1"].Terminals.Count
Usage locations (collections)
The following objects contain the GeneralNetworkTerminalCollection collection:
Property List
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
Property Details
Method Details
- Contains (label string)
- Checks if the collection contains an item with the given label.
- Item (index number)
- Returns the Terminal at the given index.
- Item (label string)
- Returns the Terminal with the given label.
- Items ()
- Returns 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.