CablePathCollection

A collection of cable paths.

Example

application = cf.Application.GetInstance()
project = application: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.Definitions.Cables.Paths:Add(corners)

    -- Get the number of paths in the collection

count = project.Definitions.Cables.Paths.Count

Inheritance

The CablePathCollection object is derived from the Object object.

Usage locations

The CablePathCollection object can be accessed from the following locations:

Property List

BoundingBox
A box indicating the bounding box of this entity. (Read only Box). (Read only Box)
Count
The number of CablePath items in the collection. (Read only number)
Label
The object label. (Read/Write string)
Type
The object type string. (Read only string)

Method List

Add (cornerslist table)
Create a cable path from a list of points. (Returns a CablePath object.)
Add (properties List of Point)
Create a cable path using table of properties. (Returns a CablePath object.)
Contains (label string)
Checks if the collection contains an item with the given label. (Returns a boolean object.)
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.)
Item (index number)
Returns the CablePath for the given index in the collection. (Returns a CablePath object.)
Item (label string)
Returns the CablePath for the given label in the collection. (Returns a CablePath object.)
Items ()
Returns a table of CablePath items. (Returns a UnsupportedType(List of CablePath) 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.
UniqueName (label string)
Generates a unique name base 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 string object.)

Static Function List

GetDefaultProperties ()
Creates a table containing the default settings to create an object. (Returns a table object.)

Property Details

BoundingBox
A box indicating the bounding box of this entity. (Read only Box).
Type
Box
Access
Read only
Count
The number of CablePath items in the collection.
Type
number
Access
Read only
Label
The object label.
Type
string
Access
Read/Write
Type
The object type string.
Type
string
Access
Read only

Method Details

Add (cornerslist table)
Create a cable path from a list of points.
Input Parameters
cornerslist(table)
The list of points defining the cable path.
Return
CablePath
The cable path.
Add (properties List of Point)
Create a cable path using table of properties.
Input Parameters
properties(List of Point)
The table of properties defining the cable path.
Return
CablePath
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 item.
Return
boolean
The success of the check.
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.
Item (index number)
Returns the CablePath for the given index in the collection.
Input Parameters
index(number)
The index of the CablePath.
Return
CablePath
The item in the collection
Item (label string)
Returns the CablePath for the given label in the collection.
Input Parameters
label(string)
The label of the CablePath.
Return
CablePath
The item in the collection
Items ()
Returns a table of CablePath items.
Return
UnsupportedType(List of CablePath)
The list of items in the collection
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.
UniqueName (label string)
Generates a unique name base 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
string
The generated unique name label for the item.

Static Function Details

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