`CableShieldCollection`

A collection of cable shields.

Example

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

    -- Add a solid shield

shield = project.Definitions.Cables.Shields:AddSingleLayerSolidShield(project.Definitions.Media.PerfectElectricConductor, 0.0005)

    -- Get the number of shields in the collection

count = project.Definitions.Cables.Shields.Count

Inheritance

The CableShieldCollection object is derived from the Object object.

Usage locations

The CableShieldCollection object can be accessed from the following locations:

Collection lists
- Cables object has collection Shields.

Property List

Count: The number of CableShield items in the collection. (Read only number)
Label: The object label. (Read/Write string)
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.)
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.)
Item (index number): Returns the CableShield for the given index in the collection. (Returns a CableShield object.)
Item (label string): Returns the CableShield for the given label in the collection. (Returns a CableShield object.)
Items (): Returns a table of CableShield items. (Returns a UnsupportedType(List of CableShield) 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

Count

The number of CableShield items in the collection.

Type: number
Access: Read only

Label

The object label.

Type: string
Access: Read/Write

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 number of filaments.
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.

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.

Item (index number)

Returns the CableShield for the given index in the collection.

Input Parameters

index(number): The index of the CableShield.

Return

CableShield: The item in the collection

Item (label string)

Returns the CableShield for the given label in the collection.

Input Parameters

label(string): The label of the CableShield.

Return

CableShield: The item in the collection

Items ()

Returns a table of CableShield items.

Return

UnsupportedType(List of CableShield): The list of items in the collection

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.