TerminalCollection
A collection of terminals on a component.
Example
app = cf.GetApplication() project = app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/Cables.cfx]]) cableSchematicComponent = project.Cables.Harnesses[1].SchematicComponents:Item(1) -- Use the TerminalsCollection to retrieve the terminals connected to a schematic component terminalCollection = cableSchematicComponent.Terminals numberOfTerminals = terminalCollection.Count terminal = terminalCollection:Item(1) -- Use the TerminalsCollection to retrieve the terminals connected to a general network project = app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/CharacteristicModes.cfx]]) generalNetworkTerminalCollection = project.SolutionConfigurations[1].Networks[1].Terminals generalNetworkTerminal = generalNetworkTerminalCollection:Item(1) -- Use the TerminalsCollection to retrieve the terminals connected to a transmission line transmissionLineTerminalCollection = project.SolutionConfigurations[1].Networks[2].Terminals transmissionLineTerminal = transmissionLineTerminalCollection:Item(1)
Usage locations (collections)
The following objects contain the TerminalCollection collection:
- CableCapacitor(.Terminals)
- CableComplexLoad(.Terminals)
- CableGeneralNetwork(.Terminals)
- CableGround(.Terminals)
- CableInductor(.Terminals)
- CableResistor(.Terminals)
- CableSchematicComponent(.Terminals)
- CableSchematicCurrentProbe(.Terminals)
- CableSchematicPort(.Terminals)
- CableSchematicVoltageProbe(.Terminals)
- CableSpiceNetwork(.Terminals)
- CableTransformer(.Terminals)
- CableVoltageControlledVoltageSource(.Terminals)
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.