CableInstance

A cable instance.

Example

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

    -- Get an existing 'CableHarness'

cableHarness = project.Cables.Harnesses["CableHarness1"]

    -- Get a 'CableInstance'

cableInstance = cableHarness.CableInstances["Cable1"]

Property List

AvailableRoutes
The available cable path routes between the source and destination connectors. (Read only List of CableRoute)
CrossSection
The cable cross section type for the cable. (Read/Write CableCrossSection)
DestinationConnector
The destination connector where the cable ends. (Read/Write CableConnector)
Included
True if the cable should be included in the cable harness solution. (Read/Write boolean)
Label
The object label. (Read/Write string)
Route
The route the cable follows. Setting this property will adjust the ShortestRouteEnabled property to false. (Read/Write CableRoute)
ShortestRouteEnabled
True is the shortest cable route must be used. (Read/Write boolean)
SourceConnector
The source connector where the cable starts. (Read/Write CableConnector)
Type
The object type string. (Read only string)

Collection List

Signals
The cable signal settings. (CableSignalSettingsCollection of CableSignalSettings.)

Method List

Delete ()
Deletes the cable from the cable harness.
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

AvailableRoutes
The available cable path routes between the source and destination connectors.
Access
Read only
CrossSection
The cable cross section type for the cable.
Type
CableCrossSection
Access
Read/Write
DestinationConnector
The destination connector where the cable ends.
Type
CableConnector
Access
Read/Write
Included
True if the cable should be included in the cable harness solution.
Type
boolean
Access
Read/Write
Label
The object label.
Type
string
Access
Read/Write
Route
The route the cable follows. Setting this property will adjust the ShortestRouteEnabled property to false.
Type
CableRoute
Access
Read/Write
ShortestRouteEnabled
True is the shortest cable route must be used.
Type
boolean
Access
Read/Write
SourceConnector
The source connector where the cable starts.
Type
CableConnector
Access
Read/Write
Type
The object type string.
Type
string
Access
Read only

Collection Details

Signals
The cable signal settings.
Type
CableSignalSettingsCollection

Method Details

Delete ()
Deletes the cable from the cable harness.
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.