CableInstance

A cable instance.

Example

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

    -- Get an existing 'CableHarness'

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

    -- Get a 'CableInstance'

cableInstance = cableHarness.CableInstances["Cable1"]

Inheritance

The CableInstance object is derived from the Object object.

Usage locations

The CableInstance object can be accessed from the following locations:

Property List

AvailableRoutes
The available cable path routes between the source and destination connectors. (Read only List of CableRoute)
BoundingBox
A box indicating the bounding box of this entity. (Read only Box). (Read only Box)
CrossSection
The cable cross section type for the cable. (Read/Write CableCrossSection)
DestinationConnector
The destination connector where the cable ends. (Read/Write CableConnector)
Included
A boolean value defining if an entity is excluded or included. (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)
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. (CableSignalCollection of CableSignal.)

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

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
BoundingBox
A box indicating the bounding box of this entity. (Read only Box).
Type
Box
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
A boolean value defining if an entity is excluded or included.
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
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
CableSignalCollection

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

Static Function Details

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