CableRoute

A Lua table of Point entities describing the path of a cable.

Example

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

    -- Get an existing 'CableInstance'

cableInstance = project.Contents.CableHarnesses["CableHarness1"].CableInstances["Cable1"]

    -- Get a list of available routes

cableRouteList = cableInstance.AvailableRoutes

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

The CableRoute object can be accessed from the following locations:

Property List

Type
The object type string. (Read only string)

Constructor 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

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.