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
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.)
- Delete ()
- Deletes the entity.
- DeleteEntities ( List of Object)
- Delete the given list of entities from the collection.
- 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.
Static Function List
- GetDefaultProperties ()
- Creates a table containing the default settings to create an object. (Returns a table object.)
Property Details
Method Details
- Add (cornerslist table)
- Create a cable path from a list of points.
- Add (properties List of Point)
- Create a cable path using table of properties.
- Delete ()
- Deletes the entity.
- DeleteEntities ( List of Object)
- Delete the given list of entities from the collection.
- 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.
- Item (label string)
- Returns the CablePath for the given label 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.
Static Function Details
- GetDefaultProperties ()
- Creates a table containing the default settings to create an object.
- Return
- table
- A table containing the default properties.