ShieldOuterLayerTransferAdmittancePropertiesCollection

A collection of frequency dependent properties for the outer layer transfer admittance definition.

Example

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

    -- Obtain a handle to the 'ShieldCollection'

shieldValues = project.Cables.Shields

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

    -- Modify the shield to use frequency defined properties
    
shield.OuterLayer.AdmittanceDefinitionMethod = cf.Enums.CableShieldAdmittanceDefinitionEnum.Custom
shield.OuterLayerTransferAdmittanceProperties:Add(1e7, 50, 0)
shield.OuterLayerTransferAdmittanceProperties:Add(1e8, 5, 0)

Usage locations (collections)

The following objects contain the ShieldOuterLayerTransferAdmittancePropertiesCollection collection:

Property List

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

Method List

Add (frequency Expression, ytMag Expression, ytPhase Expression)
Add a frequency property specification to the shield.
Item (index number)
Returns the ShieldOuterLayerTransferAdmittanceProperties at the given index. (Returns a ShieldOuterLayerTransferAdmittanceProperties object.)
Modify (index number, frequency Expression, ytMag Expression, ytPhase Expression)
Modify a frequency property specification.
Remove (index number)
Removes a frequency property specification.

Index List

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

Property Details

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

Method Details

Add (frequency Expression, ytMag Expression, ytPhase Expression)
Add a frequency property specification to the shield.
Input Parameters
frequency(Expression)
The frequency.
ytMag(Expression)
Yt magnitude.
ytPhase(Expression)
Yt phase.
Item (index number)
Returns the ShieldOuterLayerTransferAdmittanceProperties at the given index.
Input Parameters
index(number)
The index of the ShieldOuterLayerTransferAdmittanceProperties.
Return
ShieldOuterLayerTransferAdmittanceProperties
The ShieldOuterLayerTransferAdmittanceProperties at the given index.
Modify (index number, frequency Expression, ytMag Expression, ytPhase Expression)
Modify a frequency property specification.
Input Parameters
index(number)
The index.
frequency(Expression)
The frequency.
ytMag(Expression)
Yt magnitude.
ytPhase(Expression)
Yt phase.
Remove (index number)
Removes a frequency property specification.
Input Parameters
index(number)
The index.