`ShieldedEnclosure`

Shielded enclosure where cables can connect to circuitry and other cables.

Example

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

    -- Retrieve a 'CableHarness'

cableHarness = project.Contents.CableHarnesses["CableHarness1"]

    -- Add Cuboid
local properties = cf.Cuboid.GetDefaultProperties()
properties.Origin.U = "-0.1"
properties.Origin.V = "0"
properties.Origin.N = "-0.1"
properties.Width = "1.2"
properties.Depth = "-0.2"
properties.Height = "0.2"
properties.LocalWorkplane.WorkplaneDefinitionOption = cf.Enums.LocalWorkplaneDefinitionEnum.UsePredefinedWorkplane
globalXY = application.Project.Definitions.Workplanes:Item("Global XY")
properties.LocalWorkplane.ReferencedWorkplane = globalXY
properties.Label = "ShieldedBox"
shieldedBox = application.Project.Contents.Geometry:AddCuboid(properties)

    -- Add ShieldedEnclosure
local region1 = shieldedBox.Regions:Item("Region1")
local cableConnector1 = application.Project.Contents.CableHarnesses:Item("CableHarness1").Connectors:Item("CableConnector1")
local cableConnector2 = application.Project.Contents.CableHarnesses:Item("CableHarness1").Connectors:Item("CableConnector2")
shieldedEnclosure1 = application.Project.Contents.CableHarnesses:Item("CableHarness1").Enclosures:Add(region1, {cableConnector1, cableConnector2})
shieldedEnclosure1.Label = "ShieldedEnclosure1"

    -- Set CableHarness
local properties2 = application.Project.Contents.CableHarnesses:Item("CableHarness1"):GetProperties()
properties2.CableCoupling = cf.Enums.CableHarnessCouplingEnum.RadiatingWithIrradiating
properties2.SolutionMethod = cf.Enums.CableHarnessSolutionMethodEnum.MoM
cablePath1 = application.Project.Contents.CableHarnesses:Item("CableHarness1").Tubes:Item("CablePath1")
properties2.Tube = cablePath1
cable1 = application.Project.Contents.CableHarnesses:Item("CableHarness1").CableInstances:Item("Cable1")
application.Project.Contents.CableHarnesses:Item("CableHarness1"):SetProperties(properties2)

    -- Add Bundle
properties3 = cf.CableBundleCrossSection.GetDefaultProperties()
properties3.ShieldType = cf.Enums.CableBundleShieldTypeEnum.InDielectricWithShield
insulation = application.Project.Definitions.Media.Dielectric:Item("Insulation")
properties3.InsulationMedium = insulation
cableShield1 = application.Project.Definitions.Cables.Shields:Item("CableShield1")
properties3.Shield = cableShield1
twistedPair1 = application.Project.Definitions.Cables.CrossSections:Item("TwistedPair1")
properties3.BundledCables[1].Cable = twistedPair1
properties3.Label = "Bundle1"
bundle1 = application.Project.Definitions.Cables.CrossSections:AddBundle(properties3)

    -- Set Connector Properties
properties4 = cableConnector1:GetProperties()
properties4.Pins[3] = {}
properties4.Pins[3].Label = "Pin3"
cableConnector1:SetProperties(properties4)

    -- Set Connector Properties
properties5 = cableConnector2:GetProperties()
properties5.Pins[3] = {}
properties5.Pins[3].Label = "Pin3"
cableConnector2:SetProperties(properties5)

    -- Set Cable Properties
properties6 = cable1:GetProperties()
properties6.CrossSection = bundle1
properties6.Signals[3] = {}
pin3 = cableConnector1.Pins:Item("Pin3")
properties6.Signals[3].Source = pin3
pin31 = cableConnector2.Pins:Item("Pin3")
properties6.Signals[3].Destination = pin31
properties6.Signals[3].SignalIndex = 2
properties6.Signals[3].Label = "Signal3"
cable1:SetProperties(properties6)

Inheritance

The ShieldedEnclosure object is derived from the Object object.

Usage locations

The ShieldedEnclosure object can be accessed from the following locations:

Methods
- ShieldedEnclosureCollection collection has method Add(table).
- ShieldedEnclosureCollection collection has method Add(List of AbstractMeshTriangleFace, List of CableConnector).
- ShieldedEnclosureCollection collection has method Add(Region, List of CableConnector).
- ShieldedEnclosureCollection collection has method Item(number).
- ShieldedEnclosureCollection collection has method Item(string).

Property List

BoundingBox: A box indicating the bounding box of this entity. (Read only Box). (Read only Box)
Connectors: The connectors connected to the enclosure. (Read/Write ObjectReferenceList)
DefinitionMethod: The method used to define the enclosure. (Read/Write EnclosureDefinitionMethodEnum)
Label: The object label. (Read/Write string)
MeshFaces: A list of mesh faces that define the enclosure. (Read/Write ObjectReferenceList)
Region: The geometry region that defines the enclosure. (Read/Write Region)
Schematic: The schematic associated with this item. (Read only Schematic)
SchematicLocation: The location of the item on the schematic. (Read only GridLocation)
SchematicRotation: The rotation of the item on the schematic. (Read only SymbolRotationEnum)
Terminals: The schematic terminals on this item. (Read only List of Terminal)
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.)
RotateSchematicSymbol (): Rotates the item on the schematic.
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.
SetSchematicLocation (location GridLocation): Sets the location of the item on the schematic.
SetSchematicRotation (rotation SymbolRotationEnum): Sets the rotation of the item on the schematic.

Static Function List

GetDefaultProperties (): Creates a table containing the default settings to create an object. (Returns a table object.)

Property Details

BoundingBox

A box indicating the bounding box of this entity. (Read only Box).

Type: Box
Access: Read only

Connectors

The connectors connected to the enclosure.

Type: ObjectReferenceList
Access: Read/Write

DefinitionMethod

The method used to define the enclosure.

Type: EnclosureDefinitionMethodEnum
Access: Read/Write

Label

The object label.

Type: string
Access: Read/Write

MeshFaces

A list of mesh faces that define the enclosure.

Type: ObjectReferenceList
Access: Read/Write

Region

The geometry region that defines the enclosure.

Type: Region
Access: Read/Write

Schematic

The schematic associated with this item.

Type: Schematic
Access: Read only

SchematicLocation

The location of the item on the schematic.

Type: GridLocation
Access: Read only

SchematicRotation

The rotation of the item on the schematic.

Type: SymbolRotationEnum
Access: Read only

Terminals

The schematic terminals on this item.

Access: Read only

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.

RotateSchematicSymbol ()

Rotates the item on the schematic.

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.

SetSchematicLocation (location GridLocation)

Sets the location of the item on the schematic.

Input Parameters

location(GridLocation): The schematic location the item should be moved to.

SetSchematicRotation (rotation SymbolRotationEnum)

Sets the rotation of the item on the schematic.

Input Parameters

rotation(SymbolRotationEnum): The rotation setting.

Static Function Details

GetDefaultProperties ()

Creates a table containing the default settings to create an object.

Return

table: A table containing the default properties.