`CableConnectorPinCollection`

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

Example

application = cf.Application.GetInstance()
project = application:Load({FEKO_HOME..[[/shared/Resources/Automation/Cables.cfx]]})

    -- Retrieve a 'CablePath' and 'CableHarness' used to construct a connector

cablePath = project.Definitions.Cables.Paths["CablePath1"]
cableHarness = project.Contents.CableHarnesses:Item("CableHarness1")

    -- Construct a 'CableConnector' with three pins

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

Inheritance

The CableConnectorPinCollection object is derived from the Object object.

Usage locations

The CableConnectorPinCollection object can be accessed from the following locations:

Collection lists
- CableConnector object has collection Pins.

Property List

Count: The number of CableConnectorPin items in the collection. (Read only number)
Label: The object label. (Read/Write string)
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.)
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 CableConnectorPin for the given index in the collection. (Returns a CableConnectorPin object.)
Item (label string): Returns the CableConnectorPin for the given label in the collection. (Returns a CableConnectorPin object.)
Items (): Returns a table of CableConnectorPin items. (Returns a UnsupportedType(List of CableConnectorPin) object.)
SetPins (pinnames string): Modifies the connector pins from a list of pin names.
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.
UniqueName (label string): Generates a unique name base 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 string object.)

Static Function List

GetDefaultProperties (): Creates a table containing the default settings to create an object. (Returns a table object.)

Property Details

Count

The number of CableConnectorPin items in the collection.

Type: number
Access: Read only

Label

The object label.

Type: string
Access: Read/Write

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 item.

Return

boolean: The success of the check.

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 CableConnectorPin for the given index in the collection.

Input Parameters

index(number): The index of the CableConnectorPin.

Return

CableConnectorPin: The item in the collection

Item (label string)

Returns the CableConnectorPin for the given label in the collection.

Input Parameters

label(string): The label of the CableConnectorPin.

Return

CableConnectorPin: The item in the collection

Items ()

Returns a table of CableConnectorPin items.

Return

UnsupportedType(List of CableConnectorPin): The list of items in the collection

SetPins (pinnames string)

Modifies the connector pins from a list of pin names.

Input Parameters

pinnames(string): A list of pin names.

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.

UniqueName (label string)

Generates a unique name base 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

string: The generated unique name label for the item.

Static Function Details

GetDefaultProperties ()

Creates a table containing the default settings to create an object.

Return

table: A table containing the default properties.