CableShield

A cable shield.

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)

    -- Modify the shield thickness
    
properties = shield:GetProperties()
properties.InnerLayer.ShieldThickness = 0.003
shield:SetProperties(properties)

Inheritance

The CableShield object is derived from the CableShieldEntity object.

Property List

GapBetweenLayers
The gap between shield layers. (Read/Write Expression)
InnerLayer
The inner shield layer settings. (Read only InnerLayerSettings)
InsulationThickness
CS_CoatingThickness. (Read only Expression)
Label
The object label. (Read/Write string)
OuterLayer
The outer shield layer settings. (Read only OuterLayerSettings)
ShieldLayerType
The shield layer type: single or double layered. (Read/Write CableShieldLayerOptionsEnum)
StretchingOptimisationMethod
The shield stretching optimisation method. (Read/Write CableShieldStretchingOptimisationMethodEnum)
Type
The object type string. (Read only string)

Collection List

InnerLayerSurfaceImpedanceProperties
The collection of inner layer surface impedance frequency dependent properties. Only applies when the ImpedanceDefinitionMethod is Custom and the SurfaceImpedanceFrequencyPropertiesSource is SpecifyManually. (ShieldInnerLayerSurfaceImpedancePropertiesCollection of ShieldInnerLayerSurfaceImpedanceProperties.)
InnerLayerTransferAdmittanceProperties
The collection of inner layer transfer admittance frequency dependent properties. Only applies when the AdmittanceDefinitionMethod is Custom and the TransferAdmittanceFrequencyPropertiesSource is Manually. (ShieldInnerLayerTransferAdmittancePropertiesCollection of ShieldInnerLayerTransferAdmittanceProperties.)
InnerLayerTransferImpedanceProperties
The collection of inner layer transfer impedance frequency dependent properties. Only applies when the ImpedanceDefinitionMethod is Custom and the TransferImpedanceFrequencyPropertiesSource is Manually. (ShieldInnerLayerTransferImpedancePropertiesCollection of ShieldInnerLayerTransferImpedanceProperties.)
OuterLayerSurfaceImpedanceProperties
The collection of outer layer surface impedance frequency dependent properties. Only applies when the ImpedanceDefinitionMethod is Custom and the SurfaceImpedanceFrequencyPropertiesSource is SpecifyManually. (ShieldOuterLayerSurfaceImpedancePropertiesCollection of ShieldOuterLayerSurfaceImpedanceProperties.)
OuterLayerTransferAdmittanceProperties
The collection of outer layer transfer admittance frequency dependent properties. Only applies when the AdmittanceDefinitionMethod is Custom and the TransferAdmittanceFrequencyPropertiesSource is Manually. (ShieldOuterLayerTransferAdmittancePropertiesCollection of ShieldOuterLayerTransferAdmittanceProperties.)
OuterLayerTransferImpedanceProperties
The collection of outer layer transfer impedance frequency dependent properties. Only applies when the ImpedanceDefinitionMethod is Custom and the TransferImpedanceFrequencyPropertiesSource is Manually. (ShieldOuterLayerTransferImpedancePropertiesCollection of ShieldOuterLayerTransferImpedanceProperties.)

Method List

Delete ()
Deletes the cable shield.
Duplicate ()
Duplicate the cable shield. (Returns a CableShieldEntity 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.)
SetProperties (properties table)
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

GapBetweenLayers
The gap between shield layers.
Type
Expression
Access
Read/Write
InnerLayer
The inner shield layer settings.
Type
InnerLayerSettings
Access
Read only
InsulationThickness
CS_CoatingThickness.
Type
Expression
Access
Read only
Label
The object label.
Type
string
Access
Read/Write
OuterLayer
The outer shield layer settings.
Type
OuterLayerSettings
Access
Read only
ShieldLayerType
The shield layer type: single or double layered.
Type
CableShieldLayerOptionsEnum
Access
Read/Write
StretchingOptimisationMethod
The shield stretching optimisation method.
Type
CableShieldStretchingOptimisationMethodEnum
Access
Read/Write
Type
The object type string.
Type
string
Access
Read only

Collection Details

InnerLayerSurfaceImpedanceProperties
The collection of inner layer surface impedance frequency dependent properties. Only applies when the ImpedanceDefinitionMethod is Custom and the SurfaceImpedanceFrequencyPropertiesSource is SpecifyManually.
Type
ShieldInnerLayerSurfaceImpedancePropertiesCollection
InnerLayerTransferAdmittanceProperties
The collection of inner layer transfer admittance frequency dependent properties. Only applies when the AdmittanceDefinitionMethod is Custom and the TransferAdmittanceFrequencyPropertiesSource is Manually.
Type
ShieldInnerLayerTransferAdmittancePropertiesCollection
InnerLayerTransferImpedanceProperties
The collection of inner layer transfer impedance frequency dependent properties. Only applies when the ImpedanceDefinitionMethod is Custom and the TransferImpedanceFrequencyPropertiesSource is Manually.
Type
ShieldInnerLayerTransferImpedancePropertiesCollection
OuterLayerSurfaceImpedanceProperties
The collection of outer layer surface impedance frequency dependent properties. Only applies when the ImpedanceDefinitionMethod is Custom and the SurfaceImpedanceFrequencyPropertiesSource is SpecifyManually.
Type
ShieldOuterLayerSurfaceImpedancePropertiesCollection
OuterLayerTransferAdmittanceProperties
The collection of outer layer transfer admittance frequency dependent properties. Only applies when the AdmittanceDefinitionMethod is Custom and the TransferAdmittanceFrequencyPropertiesSource is Manually.
Type
ShieldOuterLayerTransferAdmittancePropertiesCollection
OuterLayerTransferImpedanceProperties
The collection of outer layer transfer impedance frequency dependent properties. Only applies when the ImpedanceDefinitionMethod is Custom and the TransferImpedanceFrequencyPropertiesSource is Manually.
Type
ShieldOuterLayerTransferImpedancePropertiesCollection

Method Details

Delete ()
Deletes the cable shield.
Duplicate ()
Duplicate the cable shield.
Return
CableShieldEntity
The 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 properties table.
SetProperties (properties table)
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(table)
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
The default properties table.