CableShield
A cable shield.
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) -- Modify the label of the shield shield.Label = "MyLabel"
Inheritance
The CableShield object is derived from the Object object.
Usage locations
The CableShield object can be accessed from the following locations:
- Properties
- CableBundleCrossSection object has property Shield.
- CableCoaxialCrossSection object has property Shield.
- Methods
- CableShieldCollection collection has method AddSingleLayerBraidedDemoulinShield(Expression, Expression, Expression, Expression, Medium).
- CableShieldCollection collection has method AddSingleLayerBraidedKleyShield(Expression, Expression, Expression, Expression, Medium).
- CableShieldCollection collection has method AddSingleLayerBraidedTyniShield(Expression, Expression, Expression, Expression, Medium).
- CableShieldCollection collection has method AddSingleLayerBraidedVanceShield(Expression, Expression, Expression, Expression, Medium).
- CableShieldCollection collection has method AddSingleLayerSolidShield(Medium, Expression).
- CableShieldCollection collection has method AddShield(table).
- CableShieldCollection collection has method Item(number).
- CableShieldCollection collection has method Item(string).
Property List
- GapBetweenLayers
- The gap between shield layers. (Read/Write ParametricExpression)
- InnerLayer
- The inner shield layer settings. (Read/Write ShieldLayerSettings)
- Label
- The object label. (Read/Write string)
- OuterLayer
- The outer shield layer settings. (Read/Write ShieldLayerSettings)
- 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)
Method List
- 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.)
- 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
- GapBetweenLayers
- The gap between shield layers.
- Type
- ParametricExpression
- Access
- Read/Write
- InnerLayer
- The inner shield layer settings.
- Type
- ShieldLayerSettings
- Access
- Read/Write
- Label
- The object label.
- Type
- string
- Access
- Read/Write
- OuterLayer
- The outer shield layer settings.
- Type
- ShieldLayerSettings
- Access
- Read/Write
- 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
Method Details
- 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.
- 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.