CableTwistedPairCrossSection

A twisted pair cable cross section.

Example

application = cf.Application.getInstance()
project = application:Load({FEKO_HOME..[[/shared/Resources/Automation/Cables.cfx]]})

    -- Add a twisted pair cross section

twistedPair = project.Definitions.Cables.CrossSections:AddTwistedPairWithInsulation(
    project.Definitions.Media.PerfectElectricConductor, 0.001,
    project.Definitions.Media.Dielectric["Insulation"], 0.0005,
    cf.Enums.TwistDirectionEnum.Left, 0.003, 0.01)

    -- Reverse the twist direction

twistedPair.TwistDirection = cf.Enums.TwistDirectionEnum.Right

Inheritance

The CableTwistedPairCrossSection object is derived from the CableCrossSection object.

Usage locations

The CableTwistedPairCrossSection object can be accessed from the following locations:

Property List

CablePerUnitLengthAccuracy
Select a higher accuracy when calculating cable per-unit-length parameters. (Read/Write CablePerUnitLengthAccuracyEnum)
CoreMedium
The conductor core medium. (Read/Write Medium)
CoreRadius
The core radius. (Read/Write ParametricExpression)
Insulated
True is the conductor is insulated. (Read/Write boolean)
InsulationMedium
The conductor insulation medium. Only applies if the 'Insulated' property is true. (Read/Write Medium)
InsulationThickness
The insulation thickness. Only applies if the 'Insulated' property is true. (Read/Write ParametricExpression)
Label
The object label. (Read/Write string)
TwistDirection
The twist direction. (Read/Write TwistDirectionEnum)
TwistPitchLength
The twist pitch length. (Read/Write ParametricExpression)
TwistRadius
The twist radius. (Read/Write ParametricExpression)
Type
The object type string. (Read only string)

Method List

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

CablePerUnitLengthAccuracy
Select a higher accuracy when calculating cable per-unit-length parameters.
Type
CablePerUnitLengthAccuracyEnum
Access
Read/Write
CoreMedium
The conductor core medium.
Type
Medium
Access
Read/Write
CoreRadius
The core radius.
Type
ParametricExpression
Access
Read/Write
Insulated
True is the conductor is insulated.
Type
boolean
Access
Read/Write
InsulationMedium
The conductor insulation medium. Only applies if the 'Insulated' property is true.
Type
Medium
Access
Read/Write
InsulationThickness
The insulation thickness. Only applies if the 'Insulated' property is true.
Type
ParametricExpression
Access
Read/Write
Label
The object label.
Type
string
Access
Read/Write
TwistDirection
The twist direction.
Type
TwistDirectionEnum
Access
Read/Write
TwistPitchLength
The twist pitch length.
Type
ParametricExpression
Access
Read/Write
TwistRadius
The twist radius.
Type
ParametricExpression
Access
Read/Write
Type
The object type string.
Type
string
Access
Read only

Method Details

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.