`CableCoaxialCrossSection`

A coaxial cable cross section.

Example

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

    -- Add a coaxial cross section
    
coaxial = project.Cables.CrossSections:AddCoaxialUsingDimensions(
    project.Media:GetPEC(),
    0.001,
    project.Media["Insulation"],
    0.001,
    project.Cables.Shields["CableShield1"]) 
    
    -- Modify the insulation radius
    
coaxial.CoreInsulatingLayers[1].Thickness = 0.002

Inheritance

The CableCoaxialCrossSection object is derived from the CableCrossSection object.

Property List

Attenuation: Attenuation (dB/m). (Read/Write Expression)
CablePerUnitLengthAccuracy: Select a higher accuracy when calculating cable per-unit-length parameters. (Read/Write CablePerUnitLengthAccuracyEnum)
Coated: True if the shield is coated. (Read/Write boolean)
CoatingMedium: The shield coating medium. Only applies if the Coated property is true. (Read/Write Medium)
CoatingThickness: The coating thickness. Only applies if the Coated property is true. (Read/Write Expression)
CoreMedium: The core conductor medium. Only applies if the 'DefinitionMethod' is'SpecifyDimensions'. (Read/Write Medium)
CoreRadius: The core radius. Only applies if the 'DefinitionMethod' is'SpecifyDimensions'. (Read/Write Expression)
DefinitionMethod: The definition method for the coaxial cable. (Read/Write CableCoaxialDefinitionEnum)
Label: The object label. (Read/Write string)
Magnitude: Magnitude of characteristic imp (Ohm). Only applies if the 'DefinitionMethod' is'SpecifyCharacteristics'. (Read/Write Expression)
OuterRadius: The outer radius of the coaxial cable. Only applies if the 'DefinitionMethod' is'SpecifyCharacteristics'. (Read/Write Expression)
PredefinedType: The predefined cable type. Only applies if 'DefinitionMethod' is 'Predefined'. (Read/Write CablePredefinedCoaxialTypeEnum)
PropagationVelocity: Velocity of propagation as a percentage. (Read/Write Expression)
Shield: The coaxial shield. Only applies if the 'DefinitionMethod' is'SpecifyDimensions' or 'SpecifyCharacteristic'. (Read/Write CableShieldEntity)
Type: The object type string. (Read only string)

Collection List

CoreInsulatingLayers: The core insulating layers. Only applies if the 'DefinitionMethod' is 'SpecifyDimensions'. (CoaxialInsulatingLayersCollection of CoaxialInsulationLayer.)

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

Attenuation

Attenuation (dB/m).

Type: Expression
Access: Read/Write

CablePerUnitLengthAccuracy

Select a higher accuracy when calculating cable per-unit-length parameters.

Type: CablePerUnitLengthAccuracyEnum
Access: Read/Write

Coated

True if the shield is coated.

Type: boolean
Access: Read/Write

CoatingMedium

The shield coating medium. Only applies if the Coated property is true.

Type: Medium
Access: Read/Write

CoatingThickness

The coating thickness. Only applies if the Coated property is true.

Type: Expression
Access: Read/Write

CoreMedium

The core conductor medium. Only applies if the 'DefinitionMethod' is'SpecifyDimensions'.

Type: Medium
Access: Read/Write

CoreRadius

The core radius. Only applies if the 'DefinitionMethod' is'SpecifyDimensions'.

Type: Expression
Access: Read/Write

DefinitionMethod

The definition method for the coaxial cable.

Type: CableCoaxialDefinitionEnum
Access: Read/Write

Label

The object label.

Type: string
Access: Read/Write

Magnitude

Magnitude of characteristic imp (Ohm). Only applies if the 'DefinitionMethod' is'SpecifyCharacteristics'.

Type: Expression
Access: Read/Write

OuterRadius

The outer radius of the coaxial cable. Only applies if the 'DefinitionMethod' is'SpecifyCharacteristics'.

Type: Expression
Access: Read/Write

PredefinedType

The predefined cable type. Only applies if 'DefinitionMethod' is 'Predefined'.

Type: CablePredefinedCoaxialTypeEnum
Access: Read/Write

PropagationVelocity

Velocity of propagation as a percentage.

Type: Expression
Access: Read/Write

Shield

The coaxial shield. Only applies if the 'DefinitionMethod' is'SpecifyDimensions' or 'SpecifyCharacteristic'.

Type: CableShieldEntity
Access: Read/Write

Type

The object type string.

Type: string
Access: Read only

Collection Details

CoreInsulatingLayers

The core insulating layers. Only applies if the 'DefinitionMethod' is 'SpecifyDimensions'.

Type: CoaxialInsulatingLayersCollection

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.