CablePointsPath

A cable path defined by a list of points.

Example

app = cf.GetApplication()
project = app: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)}
path = project.Cables.Paths:Add(corners)

    -- Change the label of the path
    
path.Label = "MyPath"

Inheritance

The CablePointsPath object is derived from the CablePath object.

Property List

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
The object label. (Read/Write string)
LocalWorkplane
The cable path workplane. (Read only 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 Expression)
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 LocalCoordinates)
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 Expression)
Type
The object type string. (Read only string)

Collection List

Corners
The collection of corner coordinates of the cable path. (CablePointsCornerCollection of LocalCoordinates.)

Method List

Delete ()
Deletes the cable path.
Duplicate ()
Duplicate the cable path. (Returns a CablePath 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 table)
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

EndTerminal
The cable path end terminal.
Type
CablePathTerminal
Access
Read only
ExportCableParametersEnabled
When enabled, cable parameters such as inductance/capacitance matrices and transfer impedance/admittance are exported to the .out file.
Type
boolean
Access
Read/Write
Label
The object label.
Type
string
Access
Read/Write
LocalWorkplane
The cable path workplane.
Type
LocalWorkplane
Access
Read only
ManuallySetReferenceVector
Enables manual specification of the reference vector.
Type
boolean
Access
Read/Write
MaxSeparationDistance
The maximum separation distance used when the SamplingPointDensityOption is 'SpecifyMaximumSeparationDistance'.
Type
Expression
Access
Read/Write
MeshRefinementEnabled
Refine the mesh close to the cable terminals.
Type
boolean
Access
Read/Write
ReferenceVector
The reference vector for cross section orientation on the cable path.
Type
LocalCoordinates
Access
Read/Write
SamplingPointDensityOption
Specify the sampling point density option.
Type
SamplingPointDensityEnum
Access
Read/Write
StartTerminal
The cable path start terminal.
Type
CablePathTerminal
Access
Read only
TwistAngle
The twist angle applied to the reference vector along the cable path.
Type
Expression
Access
Read/Write
Type
The object type string.
Type
string
Access
Read only

Collection Details

Corners
The collection of corner coordinates of the cable path.
Type
CablePointsCornerCollection

Method Details

Delete ()
Deletes the cable path.
Duplicate ()
Duplicate the cable path.
Return
CablePath
The 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 properties table.
SetProperties (properties table)
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(table)
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
The default properties table.