CableRoute

A cable route consisting of multiple cable paths.

Example

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

    -- Get an existing 'CableInstance'

cableInstance = project.Cables.Harnesses["CableHarness1"].CableInstances["Cable1"]
    
    -- Get a list of available routes
    
cableRouteList = cableInstance.AvailableRoutes

    -- Query the length of an available route

length = cableRouteList[1].Length

    -- Check available routes between two points

startPoint = cf.Point(0,0,0)
endPoint = cf.Point(1,0,0)
cableRouteListFromPoints = cf.CableRoute.GetAvailableRoutes(startPoint, endPoint)

Usage locations (object properties)

The following objects have properties using the CableRoute object:

Property List

End
The end point of the route. (Read only Point)
Label
The route label. (Read only string)
Length
The length of the route. (Read only number)
Start
The start point of the route. (Read only Point)
Type
The object type string. (Read only string)

Static Function List

GetAvailableRoutes (start Point, end Point)
The available cable path routes between the start and end points. (Returns a List of CableRoute object.)

Property Details

End
The end point of the route.
Type
Point
Access
Read only
Label
The route label.
Type
string
Access
Read only
Length
The length of the route.
Type
number
Access
Read only
Start
The start point of the route.
Type
Point
Access
Read only
Type
The object type string.
Type
string
Access
Read only

Static Function Details

GetAvailableRoutes (start Point, end Point)
The available cable path routes between the start and end points.
Input Parameters
start(Point)
The start point.
end(Point)
The end point.
Return
List of CableRoute
The available cable path routes.