CableConnectorPinCollection

A collection of of connector pins that can be connected to cable signals and cable schematic components.

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)

Usage locations (collections)

The following objects contain the CableConnectorPinCollection collection:

Property List

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

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 CableConnectorPin at the given index. (Returns a CableConnectorPin object.)
Item (label string)
Returns the CableConnectorPin with the given label. (Returns a CableConnectorPin object.)
Items ()
Returns a table of CableConnectorPin. (Returns a List of CableConnectorPin object.)
SetPins (pinnames List of string)
Modifies the connector pins from a list of pin names.
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 CableConnectorPin at the given index in the collection. (Read CableConnectorPin)
[string]
Returns the CableConnectorPin with the given name in the collection. (Read CableConnectorPin)

Property Details

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

Method Details

Contains (label string)
Checks if the collection contains an item with the given label.
Input Parameters
label(string)
The label of the CableConnectorPin.
Return
boolean
The success of the check.
Item (index number)
Returns the CableConnectorPin at the given index.
Input Parameters
index(number)
The index of the CableConnectorPin.
Return
CableConnectorPin
The CableConnectorPin at the given index.
Item (label string)
Returns the CableConnectorPin with the given label.
Input Parameters
label(string)
The label of the CableConnectorPin.
Return
CableConnectorPin
The CableConnectorPin with the given label.
Items ()
Returns a table of CableConnectorPin.
Return
List of CableConnectorPin
A table of CableConnectorPin.
SetPins (pinnames List of string)
Modifies the connector pins from a list of pin names.
Input Parameters
pinnames(List of string)
A list of pin names.
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 CableConnectorPin.