CableSingleConductorCrossSection

A single conductor cable cross section.

Example

app = cf.GetApplication()
project = app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/Cables.cfx]])

    -- Add a single conductor cross section
    
conductor = project.Cables.CrossSections:AddSingleConductorWithInsulation(
    project.Media:GetPEC(), 0.001,
    project.Media["Insulation"], 0.0005)

    -- Remove the insulation from the conductor
    
conductor.Insulated = false

Inheritance

The CableSingleConductorCrossSection object is derived from the CableCrossSection object.

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 code radius. (Read/Write Expression)
Insulated
True if 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 Expression)
Label
The object label. (Read/Write string)
Type
The object type string. (Read only string)

Method List

Delete ()
Deletes the cable cross section.
Duplicate ()
Duplicate the cable cross section. (Returns a CableCrossSection 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

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 code radius.
Type
Expression
Access
Read/Write
Insulated
True if 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
Expression
Access
Read/Write
Label
The object label.
Type
string
Access
Read/Write
Type
The object type string.
Type
string
Access
Read only

Method Details

Delete ()
Deletes the cable cross section.
Duplicate ()
Duplicate the cable cross section.
Return
CableCrossSection
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.