CableBundleCableSpecificationCollection

A collection of internal cables for a cable bundle cross section.

Example

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

    -- Add a cable bundle cross section

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

    -- Add another single conductor to the cable bundle

bundle.BundledCables:Add(project.Cables.CrossSections["SingleConductor1"])

Usage locations (collections)

The following objects contain the CableBundleCableSpecificationCollection collection:

Property List

Count
The number of CableBundleCableSpecification items in the collection. (Read only number)

Method List

Add (cable CableCrossSection, xOffect Expression, yOffect Expression, rotation Expression)
Add a cable to the bundle. This method can only be used when the AutoBundleEnabled property on the CableBundleCrossSection object is set to false.
Add (cable CableCrossSection)
Add a cable to the bundle and auto-bundle. This method can only be used when the AutoBundleEnabled property on the CableBundleCrossSection object is set to true.
Item (index number)
Returns the CableBundleCableSpecification at the given index. (Returns a CableBundleCableSpecification object.)
Modify (index number, cable CableCrossSection, xOffect Expression, yOffect Expression, rotation Expression)
Modify a cable in the bundle. This method can only be used when the AutoBundleEnabled property on the CableBundleCrossSection object is set to false.
Modify (index number, cable CableCrossSection)
Modify a cable in the bundle. This method can only be used when the AutoBundleEnabled property on the CableBundleCrossSection object is set to true.
Remove (index number)
Removes a cable from the cable bundle.

Index List

[number]
Returns the CableBundleCableSpecification at the given index in the collection. (Read CableBundleCableSpecification)

Property Details

Count
The number of CableBundleCableSpecification items in the collection.
Type
number
Access
Read only

Method Details

Add (cable CableCrossSection, xOffect Expression, yOffect Expression, rotation Expression)
Add a cable to the bundle. This method can only be used when the AutoBundleEnabled property on the CableBundleCrossSection object is set to false.
Input Parameters
cable(CableCrossSection)
The cable cross section to add.
xOffect(Expression)
The x offset of the cable.
yOffect(Expression)
The y offset of the cable.
rotation(Expression)
The rotation of the cable.
Add (cable CableCrossSection)
Add a cable to the bundle and auto-bundle. This method can only be used when the AutoBundleEnabled property on the CableBundleCrossSection object is set to true.
Input Parameters
cable(CableCrossSection)
The cable cross section to add.
Item (index number)
Returns the CableBundleCableSpecification at the given index.
Input Parameters
index(number)
The index of the CableBundleCableSpecification.
Return
CableBundleCableSpecification
The CableBundleCableSpecification at the given index.
Modify (index number, cable CableCrossSection, xOffect Expression, yOffect Expression, rotation Expression)
Modify a cable in the bundle. This method can only be used when the AutoBundleEnabled property on the CableBundleCrossSection object is set to false.
Input Parameters
index(number)
The index of the cable to modify.
cable(CableCrossSection)
The new cable cross section.
xOffect(Expression)
The x offset of the cable.
yOffect(Expression)
The y offset of the cable.
rotation(Expression)
The rotation of the cable.
Modify (index number, cable CableCrossSection)
Modify a cable in the bundle. This method can only be used when the AutoBundleEnabled property on the CableBundleCrossSection object is set to true.
Input Parameters
index(number)
The index of the cable to modify.
cable(CableCrossSection)
The new cable cross section.
Remove (index number)
Removes a cable from the cable bundle.
Input Parameters
index(number)
The index of the cable to remove.