`CableCoaxialCrossSection`

A coaxial cable cross section.

Example

application = cf.Application.getInstance()

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

    -- Add a coaxial cross section

coaxial = project.Definitions.Cables.CrossSections:AddCoaxialUsingDimensions(
    project.Definitions.Media.PerfectElectricConductor,
    0.001,
    project.Definitions.Media.Dielectric:Item("Insulation"),
    0.001,
    project.Definitions.Cables.Shields["CableShield1"])

    -- Modify the insulation radius

coaxial.CoreInsulatingLayers[1].Thickness = 0.002

Inheritance

The CableCoaxialCrossSection object is derived from the CableCrossSection object.

Usage locations

The CableCoaxialCrossSection object can be accessed from the following locations:

Methods
- CableCrossSectionCollection collection has method AddCoaxial(table).
- CableCrossSectionCollection collection has method AddCoaxialUsingDimensions(Medium, Expression, Medium, Expression, CableShield).
- CableCrossSectionCollection collection has method AddCoaxialUsingDimensionsWithCoating(Medium, Expression, Medium, Expression, CableShield, Medium, Expression).
- CableCrossSectionCollection collection has method AddCoaxialUsingPropagationCharacteristics(Expression, Expression, Expression, Expression, CableShield).
- CableCrossSectionCollection collection has method AddCoaxialUsingPropagationCharacteristicsWithCoating(Expression, Expression, Expression, Expression, CableShield, Medium, Expression).
- CableCrossSectionCollection collection has method AddPredefinedCoaxial(CablePredefinedCoaxialTypeEnum).

Property List

Attenuation: Attenuation (dB/m). (Read/Write ParametricExpression)
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 ParametricExpression)
CoreInsulatingLayers: The core insulating layers. Only applies if the 'DefinitionMethod' is 'SpecifyDimensions'. (Read/Write CoaxialInsulationLayerList)
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 ParametricExpression)
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 ParametricExpression)
OuterRadius: The outer radius of the coaxial cable. Only applies if the 'DefinitionMethod' is'SpecifyCharacteristics'. (Read/Write ParametricExpression)
PredefinedType: The predefined cable type. Only applies if 'DefinitionMethod' is 'Predefined'. (Read/Write CablePredefinedCoaxialTypeEnum)
PropagationVelocity: Velocity of propagation as a percentage. (Read/Write ParametricExpression)
Shield: The coaxial shield. Only applies if the 'DefinitionMethod' is'SpecifyDimensions' or 'SpecifyCharacteristic'. (Read/Write CableShield)
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

Attenuation

Attenuation (dB/m).

Type: ParametricExpression
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: ParametricExpression
Access: Read/Write

CoreInsulatingLayers

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

Type: CoaxialInsulationLayerList
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: ParametricExpression
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: ParametricExpression
Access: Read/Write

OuterRadius

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

Type: ParametricExpression
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: ParametricExpression
Access: Read/Write

Shield

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

Type: CableShield
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.