TerminalCollection
A collection of terminals on a component.
Example
application = cf.Application.getInstance() project = application:Load({FEKO_HOME..[[/shared/Resources/Automation/Cables.cfx]]}) terminalCollection = project.Contents.CableHarnesses[1].CableSchematic.Terminals -- Use the TerminalsCollection to retrieve the terminals connected to a schematic component numberOfTerminals = terminalCollection.Count terminal = terminalCollection:Item(1) -- Use the TerminalsCollection to retrieve the terminals connected to a general network project = application:Load({FEKO_HOME..[[/shared/Resources/Automation/CharacteristicModes.cfx]]}) generalNetworkTerminalCollection = project.Contents.SolutionConfigurations.GlobalNetworks[1].Ports generalNetworkTerminal = generalNetworkTerminalCollection:Item(1) -- Use the TerminalsCollection to retrieve the terminals connected to a transmission line transmissionLineTerminalCollection = project.Contents.SolutionConfigurations.GlobalNetworks[2].Ports transmissionLineTerminal = transmissionLineTerminalCollection:Item(1)
Inheritance
The TerminalCollection object is derived from the Object object.
Usage locations
The TerminalCollection object can be accessed from the following locations:
Property List
Method List
- Delete ()
- Deletes the entity.
- Duplicate ()
- Duplicates the entity. (Returns a Object object.)
- GetProperties ()
- Returns a table of properties representing the state of the object. The properties table can be used with the SetProperties method to change multiple properties of the object in one step. (Returns a table object.)
- Item (index number)
- Returns the Terminal for the given index in the collection. (Returns a Terminal object.)
- Item (label string)
- Returns the Terminal for the given label in the collection. (Returns a Terminal object.)
- Items ()
- Returns a table of Terminal items. (Returns a UnsupportedType(List of Terminal) object.)
- SetProperties (properties Object)
- Modifies the state of the object using the provided table of properties. This method is used to modify multiple properties of the object in a single step.
Static Function List
- GetDefaultProperties ()
- Creates a table containing the default settings to create an object. (Returns a table object.)
Property Details
Method Details
- Delete ()
- Deletes the entity.
- Duplicate ()
- Duplicates the entity.
- Return
- Object
- The new (duplicated) entity.
- GetProperties ()
- Returns a table of properties representing the state of the object. The properties table can be used with the SetProperties method to change multiple properties of the object in one step.
- Return
- table
- A table defining the properties.
- Item (index number)
- Returns the Terminal for the given index in the collection.
- Item (label string)
- Returns the Terminal for the given label in the collection.
- Items ()
- Returns a table of Terminal items.
- Return
- UnsupportedType(List of Terminal)
- The list of items in the collection
- SetProperties (properties Object)
- Modifies the state of the object using the provided table of properties. This method is used to modify multiple properties of the object in a single step.
- Input Parameters
- properties(Object)
- A table of properties defining the new state of the object.
Static Function Details
- GetDefaultProperties ()
- Creates a table containing the default settings to create an object.
- Return
- table
- A table containing the default properties.