CableConnector

A cable connector.

Example

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

    -- Retrieve a 'CableHarness'

cableHarness = project.Contents.CableHarnesses["CableHarness1"]

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

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

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

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

Inheritance

The CableConnector object is derived from the Object object.

Usage locations

The CableConnector object can be accessed from the following locations:

Property List

BoundingBox
A box indicating the bounding box of this entity. (Read only Box). (Read only Box)
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)
Schematic
The schematic associated with this item. (Read only Schematic)
SchematicLocation
The location of the item on the schematic. (Read only GridLocation)
SchematicRotation
The rotation of the item on the schematic. (Read only SymbolRotationEnum)
Terminals
The schematic terminals on this item. (Read only List of Terminal)
Type
The object type string. (Read only string)
Visible
Specifies whether the geometry must be shown or hidden. (Read/Write boolean)

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 ()
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.)
RotateSchematicSymbol ()
Rotates the item on the schematic.
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.
SetSchematicLocation (location GridLocation)
Sets the location of the item on the schematic.
SetSchematicRotation (rotation SymbolRotationEnum)
Sets the rotation of the item on the schematic.

Static Function List

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

Property Details

BoundingBox
A box indicating the bounding box of this entity. (Read only Box).
Type
Box
Access
Read only
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
Schematic
The schematic associated with this item.
Type
Schematic
Access
Read only
SchematicLocation
The location of the item on the schematic.
Type
GridLocation
Access
Read only
SchematicRotation
The rotation of the item on the schematic.
Type
SymbolRotationEnum
Access
Read only
Terminals
The schematic terminals on this item.
Access
Read only
Type
The object type string.
Type
string
Access
Read only
Visible
Specifies whether the geometry must be shown or hidden.
Type
boolean
Access
Read/Write

Collection Details

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

Method Details

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.
RotateSchematicSymbol ()
Rotates the item on the schematic.
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.
SetSchematicLocation (location GridLocation)
Sets the location of the item on the schematic.
Input Parameters
location(GridLocation)
The schematic location the item should be moved to.
SetSchematicRotation (rotation SymbolRotationEnum)
Sets the rotation of the item on the schematic.
Input Parameters
rotation(SymbolRotationEnum)
The rotation setting.

Static Function Details

GetDefaultProperties ()
Creates a table containing the default settings to create an object.
Return
table
A table containing the default properties.