PortTerminalWiresCollection
A collection of schematic wires.
Example
app = cf.GetApplication() project = app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/Cables.cfx]]) cableSchematicComponent = project.Cables.Harnesses[1].SchematicComponents:Item(1) -- Use the wires collection to retrieve the wires connected to a cable schematic terminal cableSchematicPortTerminalWiresCollection = cableSchematicComponent.Terminals[1].Wires cableSchematicWire = cableSchematicPortTerminalWiresCollection:Item(1) -- Use the wires collection to retrieve the wires connected to a general network terminal project = app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/CharacteristicModes.cfx]]) generalNetworkTerminal = project.SolutionConfigurations[1].Networks[1].Terminals[1] generalNetworkPortTerminalWiresCollection = generalNetworkTerminal.Wires generalNetworkWire = generalNetworkPortTerminalWiresCollection:Item(1) -- Use the wires collection to retrieve the wires connected to a transmission line terminal transmissionLineTerminal = project.SolutionConfigurations[1].Networks[1].Terminals[1] transmissionLinePortTerminalWiresCollection = transmissionLineTerminal.Wires transmissionLineWire = transmissionLinePortTerminalWiresCollection:Item(1)
Usage locations (collections)
The following objects contain the PortTerminalWiresCollection 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 SchematicWire at the given index. (Returns a SchematicWire object.)
- Item (label string)
- Returns the SchematicWire with the given label. (Returns a SchematicWire object.)
- Items ()
- Returns a table of SchematicWire. (Returns a List of SchematicWire 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 SchematicWire at the given index in the collection. (Read SchematicWire)
- [string]
- Returns the SchematicWire with the given name in the collection. (Read SchematicWire)
Property Details
Method Details
- Contains (label string)
- Checks if the collection contains an item with the given label.
- Item (index number)
- Returns the SchematicWire at the given index.
- Input Parameters
- index(number)
- The index of the SchematicWire.
- Return
- SchematicWire
- The SchematicWire at the given index.
- Item (label string)
- Returns the SchematicWire with the given label.
- Input Parameters
- label(string)
- The label of the SchematicWire.
- Return
- SchematicWire
- The SchematicWire with the given label.
- Items ()
- Returns a table of SchematicWire.
- Return
- List of SchematicWire
- A table of SchematicWire.
- 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.