ShieldLayerSettings
The shield layer settings.
Example
application = cf.Application.getInstance() project = application:Load({FEKO_HOME..[[/shared/Resources/Automation/Cables.cfx]]}) -- Add a double layer solid shield shield = project.Definitions.Cables.Shields:AddSingleLayerSolidShield(project.Definitions.Media.PerfectElectricConductor, 0.0005) -- Modify the shield thickness innerLayerSettings = shield.InnerLayer innerLayerSettings.ShieldThickness = 0.003
Inheritance
The ShieldLayerSettings object is derived from the CompositeValue object.
Usage locations
The ShieldLayerSettings object can be accessed from the following locations:
- Properties
- CableShield object has property InnerLayer.
- CableShield object has property OuterLayer.
- Methods
- ShieldLayerSettingsList object has method Append().
- ShieldLayerSettingsList object has method Get(number).
Property List
- AdmittanceDefinitionMethod
- The shield admittance definition method. (Read/Write CableShieldAdmittanceDefinitionEnum)
- BraidFixingMaterialApplied
- True if a braid-fixing material is used. Only applies when the ImpedanceDefinitionMethod is BraidedKley. (Read/Write boolean)
- FilamentDiameter
- The filament diameter. Only applies when the ImpedanceDefinitionMethod is BraidedKley, BraidedVance, BraidedDemoulin or BraidedTyni. (Read/Write ParametricExpression)
- FilamentMedium
- The filament medium. Only applies when the ImpedanceDefinitionMethod is BraidedKley, BraidedVance, BraidedDemoulin or BraidedTyni. (Read/Write Medium)
- ImpedanceDefinitionMethod
- The shield impedance definition method. (Read/Write CableShieldDefinitionEnum)
- InsideBraidFixingMedium
- The inside braid-fixing material. Only applies when the BraidFixingMaterialApplied is true and when the ImpedanceDefinitionMethod is BraidedKley. (Read/Write Medium)
- MinimumOpticalCoverage
- The minimum optical coverage (%). Only applies when the ImpedanceDefinitionMethod is BraidedKley, BraidedVance, BraidedDemoulin or BraidedTyni. (Read/Write ParametricExpression)
- NumberOfCarriers
- The number of carriers in the braided weave. Only applies when the ImpedanceDefinitionMethod is BraidedKley, BraidedVance, BraidedDemoulin or BraidedTyni. (Read/Write ParametricExpression)
- NumberOfFilaments
- The number of filaments in the braided weave. Only applies when the ImpedanceDefinitionMethod is BraidedKley, BraidedVance, BraidedDemoulin or BraidedTyni. (Read/Write ParametricExpression)
- OutsideBraidFixingMedium
- The outside braid-fixing material. Only applies when the BraidFixingMaterialApplied is true and when the ImpedanceDefinitionMethod is BraidedKley. (Read/Write Medium)
- ShieldMedium
- The shield medium. Only applies if the ImpedanceDefinitionMethod property is Solid or when both the ImpedanceDefinitionMethod is Custom and the SurfaceImpedanceFrequencyPropertiesSource is SolidMetal. (Read/Write Medium)
- ShieldThickness
- The shield thickness. Only applies if the ImpedanceDefinitionMethod property is Solid or Custom. (Read/Write ParametricExpression)
- SurfaceImpedanceFrequencyPropertiesFile
- The Surface impedance frequency dependent properties file name. Only applies when the ImpedanceDefinitionMethod is Custom and the SurfaceImpedanceFrequencyPropertiesSource is FromFile. (Read/Write FileReference)
- SurfaceImpedanceFrequencyPropertiesSource
- The surface impedance frequency dependent properties source. Only applies when the ImpedanceDefinitionMethod is Custom. (Read/Write CableShieldSurfaceImpedanceFrequencyDefinitionSourceEnum)
- SurfaceImpedanceInterpolationMethod
- The surface impedance interpolation method. Only applies when the ImpedanceDefinitionMethod is Custom and SurfaceImpedanceFrequencyPropertiesSource is FromFile or SpecifyManually. (Read/Write CableShieldInterpolationMethodEnum)
- TransferAdmittanceFrequencyPropertiesFile
- The transfer admittance frequency dependent properties file name. Only applies when the AdmittanceDefinitionMethod is Custom and the TransferAdmittanceFrequencyPropertiesSource is FromFile. (Read/Write FileReference)
- TransferAdmittanceFrequencyPropertiesSource
- The transfer admittance frequency dependent properties source. Only applies when the AdmittanceDefinitionMethod is Custom. (Read/Write CableShieldTransferAdmittanceFrequencyDefinitionSourceEnum)
- TransferAdmittanceInterpolationMethod
- The transfer admittance interpolation method. Only applies when the AdmittanceDefinitionMethod is Custom. (Read/Write CableShieldInterpolationMethodEnum)
- TransferCapacitance
- The transfer capacitance. Only applies when the AdmittanceDefinitionMethod is TransferCapacitance. (Read/Write ParametricExpression)
- TransferImpedanceFrequencyPropertiesFile
- The transfer impedance frequency dependent properties file name. Only applies when the ImpedanceDefinitionMethod is Custom and the TransferImpedanceFrequencyPropertiesSource is FromFile. (Read/Write FileReference)
- TransferImpedanceFrequencyPropertiesSource
- The transfer impedance frequency dependent properties source. Only applies when the ImpedanceDefinitionMethod is Custom. (Read/Write CableShieldTransferImpedanceFrequencyDefinitionSourceEnum)
- TransferImpedanceInterpolationMethod
- The transfer impedance interpolation method. Only applies when the ImpedanceDefinitionMethod is Custom. (Read/Write CableShieldInterpolationMethodEnum)
- WeaveAngle
- The braided weave angle. Only applies when the ImpedanceDefinitionMethod is BraidedKley, BraidedVance, BraidedDemoulin or BraidedTyni. (Read/Write ParametricExpression)
- WeaveAngleDeviation
- The deviation allowed for the braided weave angle. Only applies when the ImpedanceDefinitionMethod is BraidedKley, BraidedVance, BraidedDemoulin or BraidedTyni. (Read/Write ParametricExpression)
- WeaveDefinitionMethod
- The weave definition method. Only applies when the ImpedanceDefinitionMethod is BraidedKley, BraidedVance, BraidedDemoulin or BraidedTyni. (Read/Write CableShieldWeaveDefinitionMethodEnum)
Property Details
- AdmittanceDefinitionMethod
- The shield admittance definition method.
- Type
- CableShieldAdmittanceDefinitionEnum
- Access
- Read/Write
- BraidFixingMaterialApplied
- True if a braid-fixing material is used. Only applies when the ImpedanceDefinitionMethod is BraidedKley.
- Type
- boolean
- Access
- Read/Write
- FilamentDiameter
- The filament diameter. Only applies when the ImpedanceDefinitionMethod is BraidedKley, BraidedVance, BraidedDemoulin or BraidedTyni.
- Type
- ParametricExpression
- Access
- Read/Write
- FilamentMedium
- The filament medium. Only applies when the ImpedanceDefinitionMethod is BraidedKley, BraidedVance, BraidedDemoulin or BraidedTyni.
- Type
- Medium
- Access
- Read/Write
- ImpedanceDefinitionMethod
- The shield impedance definition method.
- Type
- CableShieldDefinitionEnum
- Access
- Read/Write
- InsideBraidFixingMedium
- The inside braid-fixing material. Only applies when the BraidFixingMaterialApplied is true and when the ImpedanceDefinitionMethod is BraidedKley.
- Type
- Medium
- Access
- Read/Write
- MinimumOpticalCoverage
- The minimum optical coverage (%). Only applies when the ImpedanceDefinitionMethod is BraidedKley, BraidedVance, BraidedDemoulin or BraidedTyni.
- Type
- ParametricExpression
- Access
- Read/Write
- NumberOfCarriers
- The number of carriers in the braided weave. Only applies when the ImpedanceDefinitionMethod is BraidedKley, BraidedVance, BraidedDemoulin or BraidedTyni.
- Type
- ParametricExpression
- Access
- Read/Write
- NumberOfFilaments
- The number of filaments in the braided weave. Only applies when the ImpedanceDefinitionMethod is BraidedKley, BraidedVance, BraidedDemoulin or BraidedTyni.
- Type
- ParametricExpression
- Access
- Read/Write
- OutsideBraidFixingMedium
- The outside braid-fixing material. Only applies when the BraidFixingMaterialApplied is true and when the ImpedanceDefinitionMethod is BraidedKley.
- Type
- Medium
- Access
- Read/Write
- ShieldMedium
- The shield medium. Only applies if the ImpedanceDefinitionMethod property is Solid or when both the ImpedanceDefinitionMethod is Custom and the SurfaceImpedanceFrequencyPropertiesSource is SolidMetal.
- Type
- Medium
- Access
- Read/Write
- ShieldThickness
- The shield thickness. Only applies if the ImpedanceDefinitionMethod property is Solid or Custom.
- Type
- ParametricExpression
- Access
- Read/Write
- SurfaceImpedanceFrequencyPropertiesFile
- The Surface impedance frequency dependent properties file name. Only applies when the ImpedanceDefinitionMethod is Custom and the SurfaceImpedanceFrequencyPropertiesSource is FromFile.
- Type
- FileReference
- Access
- Read/Write
- SurfaceImpedanceFrequencyPropertiesSource
- The surface impedance frequency dependent properties source. Only applies when the ImpedanceDefinitionMethod is Custom.
- Type
- CableShieldSurfaceImpedanceFrequencyDefinitionSourceEnum
- Access
- Read/Write
- SurfaceImpedanceInterpolationMethod
- The surface impedance interpolation method. Only applies when the ImpedanceDefinitionMethod is Custom and SurfaceImpedanceFrequencyPropertiesSource is FromFile or SpecifyManually.
- Type
- CableShieldInterpolationMethodEnum
- Access
- Read/Write
- TransferAdmittanceFrequencyPropertiesFile
- The transfer admittance frequency dependent properties file name. Only applies when the AdmittanceDefinitionMethod is Custom and the TransferAdmittanceFrequencyPropertiesSource is FromFile.
- Type
- FileReference
- Access
- Read/Write
- TransferAdmittanceFrequencyPropertiesSource
- The transfer admittance frequency dependent properties source. Only applies when the AdmittanceDefinitionMethod is Custom.
- Type
- CableShieldTransferAdmittanceFrequencyDefinitionSourceEnum
- Access
- Read/Write
- TransferAdmittanceInterpolationMethod
- The transfer admittance interpolation method. Only applies when the AdmittanceDefinitionMethod is Custom.
- Type
- CableShieldInterpolationMethodEnum
- Access
- Read/Write
- TransferCapacitance
- The transfer capacitance. Only applies when the AdmittanceDefinitionMethod is TransferCapacitance.
- Type
- ParametricExpression
- Access
- Read/Write
- TransferImpedanceFrequencyPropertiesFile
- The transfer impedance frequency dependent properties file name. Only applies when the ImpedanceDefinitionMethod is Custom and the TransferImpedanceFrequencyPropertiesSource is FromFile.
- Type
- FileReference
- Access
- Read/Write
- TransferImpedanceFrequencyPropertiesSource
- The transfer impedance frequency dependent properties source. Only applies when the ImpedanceDefinitionMethod is Custom.
- Type
- CableShieldTransferImpedanceFrequencyDefinitionSourceEnum
- Access
- Read/Write
- TransferImpedanceInterpolationMethod
- The transfer impedance interpolation method. Only applies when the ImpedanceDefinitionMethod is Custom.
- Type
- CableShieldInterpolationMethodEnum
- Access
- Read/Write
- WeaveAngle
- The braided weave angle. Only applies when the ImpedanceDefinitionMethod is BraidedKley, BraidedVance, BraidedDemoulin or BraidedTyni.
- Type
- ParametricExpression
- Access
- Read/Write
- WeaveAngleDeviation
- The deviation allowed for the braided weave angle. Only applies when the ImpedanceDefinitionMethod is BraidedKley, BraidedVance, BraidedDemoulin or BraidedTyni.
- Type
- ParametricExpression
- Access
- Read/Write
- WeaveDefinitionMethod
- The weave definition method. Only applies when the ImpedanceDefinitionMethod is BraidedKley, BraidedVance, BraidedDemoulin or BraidedTyni.
- Type
- CableShieldWeaveDefinitionMethodEnum
- Access
- Read/Write