CableConnectorCollection

A collection of CableConnectors.

Example

app = cf.GetApplication()
project = app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/Cables.cfx]])
    
    -- Retrieve a 'CablePath' and 'CableHarness' used to construct a connector
    
cablePath = project.Cables.Paths["CablePath1"]
cableHarness = project.Cables.Harnesses:Item("CableHarness1")

    -- Construct a 'CableConnector' with three pins

pinList = {"StartPin1", "StartPin2", "StartPin3"}
CableConnector = cableHarness.Connectors:Add(cablePath.StartTerminal, pinList)

    -- Check if there is a connector on the harness with a specific label

found = cableHarness.Connectors:Contains("CableConnector2")

Usage locations (collections)

The following objects contain the CableConnectorCollection collection:

Property List

Count
The number of CableConnector items in the collection. (Read only number)
Type
The object type string. (Read only string)

Method List

Add (terminal CablePathTerminal, pinNames List of string)
Adds a new cable connector to the harness. (Returns a CableConnector object.)
Add (position Coordinate, pinNames List of string)
Adds a new cable connector to the harness. (Returns a CableConnector object.)
Add (properties table, pinNames List of string)
Adds a new cable connector to the harness using the table of properties. (Returns a CableConnector object.)
Contains (label string)
Checks if the collection contains an item with the given label. (Returns a boolean object.)
Item (index number)
Returns the CableConnector at the given index. (Returns a CableConnector object.)
Item (label string)
Returns the CableConnector with the given label. (Returns a CableConnector object.)
Items ()
Returns a table of CableConnector. (Returns a List of CableConnector 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 CableConnector at the given index in the collection. (Read CableConnector)
[string]
Returns the CableConnector with the given name in the collection. (Read CableConnector)

Property Details

Count
The number of CableConnector items in the collection.
Type
number
Access
Read only
Type
The object type string.
Type
string
Access
Read only

Method Details

Add (terminal CablePathTerminal, pinNames List of string)
Adds a new cable connector to the harness.
Input Parameters
terminal(CablePathTerminal)
The cable path terminal the connector is connected to.
pinNames(List of string)
The names of the connector pins.
Return
CableConnector
The cable connector.
Add (position Coordinate, pinNames List of string)
Adds a new cable connector to the harness.
Input Parameters
position(Coordinate)
The position of the cable connector.
pinNames(List of string)
The names of the connector pins.
Return
CableConnector
The cable connector.
Add (properties table, pinNames List of string)
Adds a new cable connector to the harness using the table of properties.
Input Parameters
properties(table)
The table of properties.
pinNames(List of string)
The names of the connector pins.
Return
CableConnector
The cable connector.
Contains (label string)
Checks if the collection contains an item with the given label.
Input Parameters
label(string)
The label of the CableConnector.
Return
boolean
The success of the check.
Item (index number)
Returns the CableConnector at the given index.
Input Parameters
index(number)
The index of the CableConnector.
Return
CableConnector
The CableConnector at the given index.
Item (label string)
Returns the CableConnector with the given label.
Input Parameters
label(string)
The label of the CableConnector.
Return
CableConnector
The CableConnector with the given label.
Items ()
Returns a table of CableConnector.
Return
List of CableConnector
A table of CableConnector.
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 CableConnector.