CablePathCollection

A collection of cable paths.

Example

app = cf.GetApplication()
project = app:NewProject()

    -- Add a cable path to the cable path collection
    
corners = {cf.Point(0,0,0), cf.Point(0,1,0), cf.Point(1,1,0), cf.Point(1,0,0)}
path = project.Cables.Paths:Add(corners)

    -- Get the number of paths in the collection

count = project.Cables.Paths.Count

Usage locations (collections)

The following objects contain the CablePathCollection collection:

Property List

Count
The number of CablePath items in the collection. (Read only number)
Type
The object type string. (Read only string)

Method List

Add (cornerslist List of Coordinate)
Create a cable path from a list of points. (Returns a CablePointsPath object.)
Add (properties table)
Create a cable path using table of properties. (Returns a CablePointsPath object.)
Contains (label string)
Checks if the collection contains an item with the given label. (Returns a boolean object.)
Item (index number)
Returns the CablePath at the given index. (Returns a CablePath object.)
Item (label string)
Returns the CablePath with the given label. (Returns a CablePath object.)
Items ()
Returns a table of CablePath. (Returns a List of CablePath object.)
UniqueName (label string)
Generates a unique name base of of the provided base name.If the base name already exists in the collection, a digit will be appended until a valid name is generated. (Returns a boolean object.)

Index List

[number]
Returns the CablePath at the given index in the collection. (Read CablePath)
[string]
Returns the CablePath with the given name in the collection. (Read CablePath)

Property Details

Count
The number of CablePath items in the collection.
Type
number
Access
Read only
Type
The object type string.
Type
string
Access
Read only

Method Details

Add (cornerslist List of Coordinate)
Create a cable path from a list of points.
Input Parameters
cornerslist(List of Coordinate)
The list of points defining the cable path.
Return
CablePointsPath
The cable path.
Add (properties table)
Create a cable path using table of properties.
Input Parameters
properties(table)
The table of properties defining the cable path.
Return
CablePointsPath
The cable path.
Contains (label string)
Checks if the collection contains an item with the given label.
Input Parameters
label(string)
The label of the CablePath.
Return
boolean
The success of the check.
Item (index number)
Returns the CablePath at the given index.
Input Parameters
index(number)
The index of the CablePath.
Return
CablePath
The CablePath at the given index.
Item (label string)
Returns the CablePath with the given label.
Input Parameters
label(string)
The label of the CablePath.
Return
CablePath
The CablePath with the given label.
Items ()
Returns a table of CablePath.
Return
List of CablePath
A table of CablePath.
UniqueName (label string)
Generates a unique name base of of the provided base name.If the base name already exists in the collection, a digit will be appended until a valid name is generated.
Input Parameters
label(string)
The base name.
Return
boolean
The generated unique name label for CablePath.