# CablePath

A cable path.

## Example

application = cf.Application.GetInstance()
project = application:NewProject()

-- Add a cable path to the model

corners = {cf.Point(0,0,0), cf.Point(0,1,0), cf.Point(1,1,0), cf.Point(1,0,0)}

-- Change the label of the path

path.Label = "MyPath"

## Inheritance

The CablePath object is derived from the Object object.

## Usage locations

The CablePath 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)
Corners
A collection of corner coordinates. (Read/Write LocalInternalCoordinateList)
EndTerminal
The cable path end terminal. (Read only CablePathTerminal)
ExportCableParametersEnabled
When enabled, cable parameters such as inductance/capacitance matrices and transfer impedance/admittance are exported to the .out file. (Read/Write boolean)
Label
LocalWorkplane
ManuallySetReferenceVector
Enables manual specification of the reference vector. (Read/Write boolean)
MaxSeparationDistance
The maximum separation distance used when the SamplingPointDensityOption is 'SpecifyMaximumSeparationDistance'. (Read/Write ParametricExpression)
MeshRefinementEnabled
Refine the mesh close to the cable terminals. (Read/Write boolean)
ReferenceVector
The reference vector for cross section orientation on the cable path. (Read/Write LocalCoordinate)
SamplingPointDensityOption
Specify the sampling point density option. (Read/Write SamplingPointDensityEnum)
StartTerminal
The cable path start terminal. (Read only CablePathTerminal)
TwistAngle
The twist angle applied to the reference vector along the cable path. (Read/Write ParametricExpression)
Type
The object type string. (Read only string)

## Collection List

Transforms
The collection of transforms on the operator. (TransformCollection of Transform.)

## Method List

CopyAndMirror (properties table)
Apply a copy and mirror using a table defining the properties. (Returns a Object object.)
CopyAndRotate (properties table, count number)
Apply a copy and rotate using a table defining the properties. (Returns a List of Object object.)
CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number)
Copy and rotate the geometry. (Returns a List of Object object.)
CopyAndTranslate (properties table, count number)
Apply a copy and translate using a table defining the properties. (Returns a List of Object object.)
CopyAndTranslate (from Point, to Point, count number)
Copy and translate the geometry. (Returns a List of Object 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.)
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

BoundingBox
A box indicating the bounding box of this entity. (Read only Box).
Type
Box
Access
Corners
A collection of corner coordinates.
Type
LocalInternalCoordinateList
Access
EndTerminal
The cable path end terminal.
Type
CablePathTerminal
Access
ExportCableParametersEnabled
When enabled, cable parameters such as inductance/capacitance matrices and transfer impedance/admittance are exported to the .out file.
Type
boolean
Access
Label
The object label.
Type
string
Access
LocalWorkplane
The source workplane.
Type
LocalWorkplane
Access
ManuallySetReferenceVector
Enables manual specification of the reference vector.
Type
boolean
Access
MaxSeparationDistance
The maximum separation distance used when the SamplingPointDensityOption is 'SpecifyMaximumSeparationDistance'.
Type
ParametricExpression
Access
MeshRefinementEnabled
Refine the mesh close to the cable terminals.
Type
boolean
Access
ReferenceVector
The reference vector for cross section orientation on the cable path.
Type
LocalCoordinate
Access
SamplingPointDensityOption
Specify the sampling point density option.
Type
SamplingPointDensityEnum
Access
StartTerminal
The cable path start terminal.
Type
CablePathTerminal
Access
TwistAngle
The twist angle applied to the reference vector along the cable path.
Type
ParametricExpression
Access
Type
The object type string.
Type
string
Access

## Collection Details

Transforms
The collection of transforms on the operator.
Type
TransformCollection

## Method Details

CopyAndMirror (properties table)
Apply a copy and mirror using a table defining the properties.
Input Parameters
properties(table)
A table of properties defining the mirror transform.
Return
Object
The mirrored geometry.
CopyAndRotate (properties table, count number)
Apply a copy and rotate using a table defining the properties.
Input Parameters
properties(table)
A table of properties defining the rotate transform.
count(number)
The number of transform copies.
Return
List of Object
The list of rotated geometry.
CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number)
Copy and rotate the geometry.
Input Parameters
origin(Point)
The coordinates of the origin of the rotation.
rotationaxis(Vector)
The axis of rotation.
angle(number)
The angle of rotation (degrees).
count(number)
The number of copies.
Return
List of Object
The list of rotated geometry.
CopyAndTranslate (properties table, count number)
Apply a copy and translate using a table defining the properties.
Input Parameters
properties(table)
A table of properties defining the translate transform.
count(number)
The number of transform copies.
Return
List of Object
The list of translated geometry.
CopyAndTranslate (from Point, to Point, count number)
Copy and translate the geometry.
Input Parameters
from(Point)
Translate from coordinate.
to(Point)
Translate to coordinate.
count(number)
The number of copies.
Return
List of Object
The list of translated geometry.
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.
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.