CableShieldCollection

A collection of cable shields.

Example

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

    -- Add a solid shield
    
shield = project.Cables.Shields:AddSolidShield(project.Media:GetPEC(), 0.0005)

    -- Get the number of shields in the collection

count = project.Cables.Shields.Count

Usage locations (collections)

The following objects contain the CableShieldCollection collection:

Property List

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

Method List

AddShield (properties table)
Create a shield from the table defining the properties. (Returns a CableShield object.)
AddSingleLayerBraidedDemoulinShield (numberOfCarriers Expression, weaveAngle Expression, numberOfFilaments Expression, filamentDiameter Expression, filamentMedium Medium)
Create a braided Demoulin shield. (Returns a CableShield object.)
AddSingleLayerBraidedKleyShield (numberOfCarriers Expression, weaveAngle Expression, numberOfFilaments Expression, filamentDiameter Expression, filamentMedium Medium)
Create a braided Kley shield. (Returns a CableShield object.)
AddSingleLayerBraidedTyniShield (numberOfCarriers Expression, weaveAngle Expression, numberOfFilaments Expression, filamentDiameter Expression, filamentMedium Medium)
Create a braided Tyni shield. (Returns a CableShield object.)
AddSingleLayerBraidedVanceShield (numberOfCarriers Expression, weaveAngle Expression, numberOfFilaments Expression, filamentDiameter Expression, filamentMedium Medium)
Create a braided Vance shield. (Returns a CableShield object.)
AddSingleLayerSolidShield (shieldMedium Medium, shieldThickness Expression)
Create a solid shield. (Returns a CableShield object.)
Contains (label string)
Checks if the collection contains an item with the given label. (Returns a boolean object.)
Item (index number)
Returns the CableShieldEntity at the given index. (Returns a CableShieldEntity object.)
Item (label string)
Returns the CableShieldEntity with the given label. (Returns a CableShieldEntity object.)
Items ()
Returns a table of CableShieldEntity. (Returns a List of CableShieldEntity 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 CableShieldEntity at the given index in the collection. (Read CableShieldEntity)
[string]
Returns the CableShieldEntity with the given name in the collection. (Read CableShieldEntity)

Property Details

Count
The number of CableShieldEntity items in the collection.
Type
number
Access
Read only
Type
The object type string.
Type
string
Access
Read only

Method Details

AddShield (properties table)
Create a shield from the table defining the properties.
Input Parameters
properties(table)
A table of properties defining the new shield.
Return
CableShield
The shield.
AddSingleLayerBraidedDemoulinShield (numberOfCarriers Expression, weaveAngle Expression, numberOfFilaments Expression, filamentDiameter Expression, filamentMedium Medium)
Create a braided Demoulin shield.
Input Parameters
numberOfCarriers(Expression)
The number of carriers.
weaveAngle(Expression)
The weave angle.
numberOfFilaments(Expression)
The number of filaments.
filamentDiameter(Expression)
The filament diameter.
filamentMedium(Medium)
The filament medium.
Return
CableShield
The shield.
AddSingleLayerBraidedKleyShield (numberOfCarriers Expression, weaveAngle Expression, numberOfFilaments Expression, filamentDiameter Expression, filamentMedium Medium)
Create a braided Kley shield.
Input Parameters
numberOfCarriers(Expression)
The number of carriers.
weaveAngle(Expression)
The weave angle.
numberOfFilaments(Expression)
The number of filaments.
filamentDiameter(Expression)
The filament diameter.
filamentMedium(Medium)
The filament medium.
Return
CableShield
The shield.
AddSingleLayerBraidedTyniShield (numberOfCarriers Expression, weaveAngle Expression, numberOfFilaments Expression, filamentDiameter Expression, filamentMedium Medium)
Create a braided Tyni shield.
Input Parameters
numberOfCarriers(Expression)
The number of carriers.
weaveAngle(Expression)
The weave angle.
numberOfFilaments(Expression)
The number of filaments.
filamentDiameter(Expression)
The filament diameter.
filamentMedium(Medium)
The filament medium.
Return
CableShield
The shield.
AddSingleLayerBraidedVanceShield (numberOfCarriers Expression, weaveAngle Expression, numberOfFilaments Expression, filamentDiameter Expression, filamentMedium Medium)
Create a braided Vance shield.
Input Parameters
numberOfCarriers(Expression)
The number of carriers.
weaveAngle(Expression)
The weave angle.
numberOfFilaments(Expression)
The number of filaments.
filamentDiameter(Expression)
The filament diameter.
filamentMedium(Medium)
The filament medium.
Return
CableShield
The shield.
AddSingleLayerSolidShield (shieldMedium Medium, shieldThickness Expression)
Create a solid shield.
Input Parameters
shieldMedium(Medium)
The shield medium.
shieldThickness(Expression)
The shield thickness.
Return
CableShield
The shield.
Contains (label string)
Checks if the collection contains an item with the given label.
Input Parameters
label(string)
The label of the CableShieldEntity.
Return
boolean
The success of the check.
Item (index number)
Returns the CableShieldEntity at the given index.
Input Parameters
index(number)
The index of the CableShieldEntity.
Return
CableShieldEntity
The CableShieldEntity at the given index.
Item (label string)
Returns the CableShieldEntity with the given label.
Input Parameters
label(string)
The label of the CableShieldEntity.
Return
CableShieldEntity
The CableShieldEntity with the given label.
Items ()
Returns a table of CableShieldEntity.
Return
List of CableShieldEntity
A table of CableShieldEntity.
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 CableShieldEntity.