`CableCrossSectionCollection`

A collection of cable cross sections.

Example

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

    -- Add a cable bundle cross section to the collection

bundledCables = 
    {
        project.Cables.CrossSections["SingleConductor1"], 
        project.Cables.CrossSections["TwistedPair1"]
    }
bundle = project.Cables.CrossSections:AddBundle(bundledCables)

    -- Get a list of all the bundles in the collection
    
bundles = project.Cables.CrossSections

Usage locations (collections)

The following objects contain the CableCrossSectionCollection collection:

Cables(.CrossSections)

Property List

Count: The number of CableCrossSection items in the collection. (Read only number)
Type: The object type string. (Read only string)

Method List

AddBundle (properties table): Create a cable bundle cross section. (Returns a CableBundleCrossSection object.)
AddBundle (cables List of CableCrossSection): Create a cable bundle cross section. (Returns a CableBundleCrossSection object.)
AddBundleWithCoating (cables List of CableCrossSection, coatingMedium Medium, coatingThickness Expression): Create a cable bundle cross section. (Returns a CableBundleCrossSection object.)
AddCoaxial (properties table): Create a coaxial cable cross section from the table defining the properties. (Returns a CableCoaxialCrossSection object.)
AddCoaxialUsingDimensions (coremedium Medium, coreradius Expression, insulationmedium Medium, insulationthickness Expression, shield CableShieldEntity): Create a coaxial cable cross section defined by its dimensions. (Returns a CableCoaxialCrossSection object.)
AddCoaxialUsingDimensionsWithCoating (coremedium Medium, coreradius Expression, insulationmedium Medium, insulationthickness Expression, shield CableShieldEntity, coatingMedium Medium, coatingThickness Expression): Create a coaxial cable cross section defined by its dimensions. (Returns a CableCoaxialCrossSection object.)
AddCoaxialUsingPropagationCharacteristics (magnitude Expression, phase Expression, attenuation Expression, vop Expression, outerradius Expression, shield CableShieldEntity): Create a coaxial cable cross section defined by its characteristics. (Returns a CableCoaxialCrossSection object.)
AddCoaxialUsingPropagationCharacteristicsWithCoating (magnitude Expression, phase Expression, attenuation Expression, vop Expression, outerradius Expression, shield CableShieldEntity, coatingMedium Medium, coatingThickness Expression): Create a coaxial cable cross section defined by its characteristics. (Returns a CableCoaxialCrossSection object.)
AddNonConductingElement (properties table): Create a non conducting element from the table defining the properties. (Returns a CableNonConductingElementCrossSection object.)
AddNonConductingElement (fibremedium Medium, radius Expression): Create a non conducting element cross section. (Returns a CableNonConductingElementCrossSection object.)
AddPredefinedCoaxial (coaxtype CablePredefinedCoaxialTypeEnum): Create a predefined coaxial cable cross section. (Returns a CableCoaxialCrossSection object.)
AddRibbon (properties table): Create a ribbon from the table defining the properties. (Returns a CableRibbonCrossSection object.)
AddRibbon (coremedium Medium, coreradius Expression, numberofcores Expression, corespacing Expression): Create a ribbon cross section. (Returns a CableRibbonCrossSection object.)
AddRibbonWithInsulation (coremedium Medium, coreradius Expression, insulationmedium Medium, insulationthickness Expression, numberofcores Expression, corespacing Expression): Create a ribbon cross section. (Returns a CableRibbonCrossSection object.)
AddSingleConductor (coremedium Medium, coreradius Expression): Create a single conductor cross section with no insulation. (Returns a CableSingleConductorCrossSection object.)
AddSingleConductor (properties table): Create a single conductor from the table defining the properties. (Returns a CableSingleConductorCrossSection object.)
AddSingleConductorWithInsulation (coremedium Medium, coreradius Expression, insulationmedium Medium, insulationthickness Expression): Create a single conductor cross section with insulation. (Returns a CableSingleConductorCrossSection object.)
AddTwistedPair (properties table): Create a twisted pair from the table defining the properties. (Returns a CableTwistedPairCrossSection object.)
AddTwistedPair (coremedium Medium, coreradius Expression, twistdirection TwistDirectionEnum, twistradius Expression, twistlength Expression): Create a twisted pair cross section. (Returns a CableTwistedPairCrossSection object.)
AddTwistedPairWithInsulation (coremedium Medium, coreradius Expression, insulationmedium Medium, insulationthickness Expression, twistdirection TwistDirectionEnum, twistradius Expression, twistlength Expression): Create a twisted pair cross section. (Returns a CableTwistedPairCrossSection object.)
Contains (label string): Checks if the collection contains an item with the given label. (Returns a boolean object.)
Item (index number): Returns the CableCrossSection at the given index. (Returns a CableCrossSection object.)
Item (label string): Returns the CableCrossSection with the given label. (Returns a CableCrossSection object.)
Items (): Returns a table of CableCrossSection. (Returns a List of CableCrossSection object.)
UniqueName (label string): Generates a unique name base of of the provided base name.If the base name already exists in the collection, a digit will be appended until a valid name is generated. (Returns a boolean object.)

Index List

[number]: Returns the CableCrossSection at the given index in the collection. (Read CableCrossSection)
[string]: Returns the CableCrossSection with the given name in the collection. (Read CableCrossSection)

Property Details

Count

The number of CableCrossSection items in the collection.

Type: number
Access: Read only

Type

The object type string.

Type: string
Access: Read only

Method Details

AddBundle (properties table)

Create a cable bundle cross section.

Input Parameters

properties(table): A table of properties defining the new bundle.

Return

CableBundleCrossSection: The cable bundle cross section.

AddBundle (cables List of CableCrossSection)

Create a cable bundle cross section.

Input Parameters

cables(List of CableCrossSection): A list of cables to include in the bundle.

Return

CableBundleCrossSection: The cable bundle cross section.

AddBundleWithCoating (cables List of CableCrossSection, coatingMedium Medium, coatingThickness Expression)

Create a cable bundle cross section.

Input Parameters

cables(List of CableCrossSection): A list of cables to include in the bundle.
coatingMedium(Medium): The coating medium.
coatingThickness(Expression): The thickness of the coating.

Return

CableBundleCrossSection: The cable bundle cross section.

AddCoaxial (properties table)

Create a coaxial cable cross section from the table defining the properties.

Input Parameters

properties(table): A table of properties defining the new coaxial cable.

Return

CableCoaxialCrossSection: The coaxial cable cross section.

AddCoaxialUsingDimensions (coremedium Medium, coreradius Expression, insulationmedium Medium, insulationthickness Expression, shield CableShieldEntity)

Create a coaxial cable cross section defined by its dimensions.

Input Parameters

coremedium(Medium): The core medium.
coreradius(Expression): The core radius.
insulationmedium(Medium): The insulation medium for the 1st layer.
insulationthickness(Expression): The insulation medium for the 1st layer.
shield(CableShieldEntity): The shield.

Return

CableCoaxialCrossSection: The coaxial cable cross section.

AddCoaxialUsingDimensionsWithCoating (coremedium Medium, coreradius Expression, insulationmedium Medium, insulationthickness Expression, shield CableShieldEntity, coatingMedium Medium, coatingThickness Expression)

Create a coaxial cable cross section defined by its dimensions.

Input Parameters

coremedium(Medium): The core medium.
coreradius(Expression): The core radius.
insulationmedium(Medium): The insulation medium for the 1st layer.
insulationthickness(Expression): The insulation medium for the 1st layer.
shield(CableShieldEntity): The shield.
coatingMedium(Medium): The coating medium.
coatingThickness(Expression): The thickness of the coating.

Return

CableCoaxialCrossSection: The coaxial cable cross section.

AddCoaxialUsingPropagationCharacteristics (magnitude Expression, phase Expression, attenuation Expression, vop Expression, outerradius Expression, shield CableShieldEntity)

Create a coaxial cable cross section defined by its characteristics.

Input Parameters

magnitude(Expression): The magnitude of the characteristic impedance (Ohm).
phase(Expression): The phase of the characteristic impedance (degrees).
attenuation(Expression): The attenuation of the propagation in (dB/m).
vop(Expression): The velocity of the propagation as a (%).
outerradius(Expression): The thickness of the insulation.
shield(CableShieldEntity): The shield.

Return

CableCoaxialCrossSection: The coaxial cable cross section.

AddCoaxialUsingPropagationCharacteristicsWithCoating (magnitude Expression, phase Expression, attenuation Expression, vop Expression, outerradius Expression, shield CableShieldEntity, coatingMedium Medium, coatingThickness Expression)

Create a coaxial cable cross section defined by its characteristics.

Input Parameters

magnitude(Expression): The magnitude of the characteristic impedance (Ohm).
phase(Expression): The phase of the characteristic impedance (degrees).
attenuation(Expression): The attenuation of the propagation in (dB/m).
vop(Expression): The velocity of the propagation as a (%).
outerradius(Expression): The thickness of the insulation.
shield(CableShieldEntity): The shield.
coatingMedium(Medium): The coating medium.
coatingThickness(Expression): The thickness of the coating.

Return

CableCoaxialCrossSection: The coaxial cable cross section.

AddNonConductingElement (properties table)

Create a non conducting element from the table defining the properties.

Input Parameters

properties(table): A table of properties defining the new non conducting element.

Return

CableNonConductingElementCrossSection: The non conducting element.

AddNonConductingElement (fibremedium Medium, radius Expression)

Create a non conducting element cross section.

Input Parameters

fibremedium(Medium): The fibre medium.
radius(Expression): The radius.

Return

CableNonConductingElementCrossSection: The non conducting element.

AddPredefinedCoaxial (coaxtype CablePredefinedCoaxialTypeEnum)

Create a predefined coaxial cable cross section.

Input Parameters

coaxtype(CablePredefinedCoaxialTypeEnum): The coaxial cable type.

Return

CableCoaxialCrossSection: The coaxial cable cross section.

AddRibbon (properties table)

Create a ribbon from the table defining the properties.

Input Parameters

properties(table): A table of properties defining the new ribbon.

Return

CableRibbonCrossSection: The ribbon.

AddRibbon (coremedium Medium, coreradius Expression, numberofcores Expression, corespacing Expression)

Create a ribbon cross section.

Input Parameters

coremedium(Medium): The core medium.
coreradius(Expression): The core radius.
numberofcores(Expression): The number of cores.
corespacing(Expression): The core spacing.

Return

CableRibbonCrossSection: The ribbon.

AddRibbonWithInsulation (coremedium Medium, coreradius Expression, insulationmedium Medium, insulationthickness Expression, numberofcores Expression, corespacing Expression)

Create a ribbon cross section.

Input Parameters

coremedium(Medium): The core medium.
coreradius(Expression): The core radius.
insulationmedium(Medium): The insulation medium.
insulationthickness(Expression): The thickness of the insulation.
numberofcores(Expression): The number of cores.
corespacing(Expression): The core spacing.

Return

CableRibbonCrossSection: The ribbon.

AddSingleConductor (coremedium Medium, coreradius Expression)

Create a single conductor cross section with no insulation.

Input Parameters

coremedium(Medium): The core medium.
coreradius(Expression): The core radius.

Return

CableSingleConductorCrossSection: The cross section.

AddSingleConductor (properties table)

Create a single conductor from the table defining the properties.

Input Parameters

properties(table): A table of properties defining the new single conductor.

Return

CableSingleConductorCrossSection: The single conductor.

AddSingleConductorWithInsulation (coremedium Medium, coreradius Expression, insulationmedium Medium, insulationthickness Expression)

Create a single conductor cross section with insulation.

Input Parameters

coremedium(Medium): The core medium.
coreradius(Expression): The core radius.
insulationmedium(Medium): The insulation medium.
insulationthickness(Expression): The thickness of the insulation.

Return

CableSingleConductorCrossSection: The cross section.

AddTwistedPair (properties table)

Create a twisted pair from the table defining the properties.

Input Parameters

properties(table): A table of properties defining the new twisted pair.

Return

CableTwistedPairCrossSection: The twisted pair.

AddTwistedPair (coremedium Medium, coreradius Expression, twistdirection TwistDirectionEnum, twistradius Expression, twistlength Expression)

Create a twisted pair cross section.

Input Parameters

coremedium(Medium): The core medium.
coreradius(Expression): The core radius.
twistdirection(TwistDirectionEnum): The twist direction.
twistradius(Expression): The twist radius.
twistlength(Expression): The twist length.

Return

CableTwistedPairCrossSection: The twisted pair.

AddTwistedPairWithInsulation (coremedium Medium, coreradius Expression, insulationmedium Medium, insulationthickness Expression, twistdirection TwistDirectionEnum, twistradius Expression, twistlength Expression)

Create a twisted pair cross section.

Input Parameters

coremedium(Medium): The core medium.
coreradius(Expression): The core radius.
insulationmedium(Medium): The insulation medium.
insulationthickness(Expression): The thickness of the insulation.
twistdirection(TwistDirectionEnum): The twist direction.
twistradius(Expression): The twist radius.
twistlength(Expression): The twist length.

Return

CableTwistedPairCrossSection: The twisted pair.

Contains (label string)

Checks if the collection contains an item with the given label.

Input Parameters

label(string): The label of the CableCrossSection.

Return

boolean: The success of the check.

Item (index number)

Returns the CableCrossSection at the given index.

Input Parameters

index(number): The index of the CableCrossSection.

Return

CableCrossSection: The CableCrossSection at the given index.

Item (label string)

Returns the CableCrossSection with the given label.

Input Parameters

label(string): The label of the CableCrossSection.

Return

CableCrossSection: The CableCrossSection with the given label.

Items ()

Returns a table of CableCrossSection.

Return

List of CableCrossSection: A table of CableCrossSection.

UniqueName (label string)

Generates a unique name base of of the provided base name.If the base name already exists in the collection, a digit will be appended until a valid name is generated.

Input Parameters

label(string): The base name.

Return

boolean: The generated unique name label for CableCrossSection.