CableConnector

A cable connector.

Example

app = cf.GetApplication()
project = app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/Cables.cfx]])

    -- Retrieve a 'CableHarness'

cableHarness = project.Cables.Harnesses:Item("CableHarness1")

    -- Retrieve the 'PathTerminal' from a 'CableConnector'

pathTerminal = cableHarness.Connectors["CableConnector1"].PathTerminal

    -- Retrieve a 'CableConnectorPin' from a 'CableConnector'

cablePin = cableHarness.Connectors["CableConnector2"].Pins["Pin2"]

Usage locations (object properties)

The following objects have properties using the CableConnector object:

Property List

Label
The object label. (Read/Write string)
PathTerminal
The path terminal that this connector is connected to. This is only available when 'PositionDefinition' is set to 'PathTerminal'. (Read/Write CablePathTerminal)
Position
The position of the connector if the Coordinate PositionDefinition is used. (Read/Write GlobalCoordinates)
PositionDefinition
The position definition method used to define the connector. This is only available when 'PositionDefinition' is set to 'Coordinate'. (Read/Write CableConnectorPositionDefinitionEnum)
Type
The object type string. (Read only string)

Collection List

Pins
The collection of connector pins that can be connected to cable signals and cable schematic components. (CableConnectorPinCollection of CableConnectorPin.)

Method List

Delete ()
Delete the cable connector.
Duplicate ()
Duplicates the cable connector. (Returns a CableConnector 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.)
SetProperties (properties table)
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

Label
The object label.
Type
string
Access
Read/Write
PathTerminal
The path terminal that this connector is connected to. This is only available when 'PositionDefinition' is set to 'PathTerminal'.
Type
CablePathTerminal
Access
Read/Write
Position
The position of the connector if the Coordinate PositionDefinition is used.
Type
GlobalCoordinates
Access
Read/Write
PositionDefinition
The position definition method used to define the connector. This is only available when 'PositionDefinition' is set to 'Coordinate'.
Type
CableConnectorPositionDefinitionEnum
Access
Read/Write
Type
The object type string.
Type
string
Access
Read only

Collection Details

Pins
The collection of connector pins that can be connected to cable signals and cable schematic components.
Type
CableConnectorPinCollection

Method Details

Delete ()
Delete the cable connector.
Duplicate ()
Duplicates the cable connector.
Return
CableConnector
The duplicated cable connector.
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 properties table.
SetProperties (properties table)
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(table)
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
The default properties table.