`ShieldedEnclosureCollection`

A collection of shielded enclosures.

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"

Inheritance

The ShieldedEnclosureCollection object is derived from the Object object.

Usage locations

The ShieldedEnclosureCollection object can be accessed from the following locations:

Collection lists

Property List

BoundingBox: A box indicating the bounding box of this entity. (Read only Box). (Read only Box)
Count: The number of ShieldedEnclosure items in the collection. (Read only number)
Label: The object label. (Read/Write string)
Type: The object type string. (Read only string)

Method List

Add (properties table): Adds a new shielded enclosure to the harness using the table of properties. (Returns a ShieldedEnclosure object.)
Add (faces List of AbstractMeshTriangleFace, connectors List of CableConnector): Adds a new shielded enclosure for the given mesh faces and cable connectors. (Returns a ShieldedEnclosure object.)
Add (region Region, connectors List of CableConnector): Adds a new shielded enclosure for the given geometry region and cable connectors. (Returns a ShieldedEnclosure object.)
Contains (label string): Checks if the collection contains an item with the given label. (Returns a boolean object.)
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.)
Item (index number): Returns the ShieldedEnclosure for the given index in the collection. (Returns a ShieldedEnclosure object.)
Item (label string): Returns the ShieldedEnclosure for the given label in the collection. (Returns a ShieldedEnclosure object.)
Items (): Returns a table of ShieldedEnclosure items. (Returns a UnsupportedType(List of ShieldedEnclosure) 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.
UniqueName (label string): Generates a unique name base of the provided base name. If the base name already exists in the collection, a digit will be appended until a valid name is generated. (Returns a string object.)

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

Count

The number of ShieldedEnclosure items in the collection.

Type: number
Access: Read only

Label

The object label.

Type: string
Access: Read/Write

Type

The object type string.

Type: string
Access: Read only

Method Details

Add (properties table)

Adds a new shielded enclosure to the harness using the table of properties.

Input Parameters

properties(table): The table of properties.

Return

ShieldedEnclosure: The shielded enclosure.

Add (faces List of AbstractMeshTriangleFace, connectors List of CableConnector)

Adds a new shielded enclosure for the given mesh faces and cable connectors.

Input Parameters

faces(List of AbstractMeshTriangleFace): The mesh faces.
connectors(List of CableConnector): The cable connectors.

Return

ShieldedEnclosure: The shielded enclosure.

Add (region Region, connectors List of CableConnector)

Adds a new shielded enclosure for the given geometry region and cable connectors.

Input Parameters

region(Region): The geometry region.
connectors(List of CableConnector): The cable connectors.

Return

ShieldedEnclosure: The shielded enclosure.

Contains (label string)

Checks if the collection contains an item with the given label.

Input Parameters

label(string): The label of the item.

Return

boolean: The success of the check.

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.

Item (index number)

Returns the ShieldedEnclosure for the given index in the collection.

Input Parameters

index(number): The index of the ShieldedEnclosure.

Return

ShieldedEnclosure: The item in the collection

Item (label string)

Returns the ShieldedEnclosure for the given label in the collection.

Input Parameters

label(string): The label of the ShieldedEnclosure.

Return

ShieldedEnclosure: The item in the collection

Items ()

Returns a table of ShieldedEnclosure items.

Return

UnsupportedType(List of ShieldedEnclosure): The list of items in the collection

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.

UniqueName (label string)

Generates a unique name base of the provided base name. If the base name already exists in the collection, a digit will be appended until a valid name is generated.

Input Parameters

label(string): The base name.

Return

string: The generated unique name label for the item.

Static Function Details

GetDefaultProperties ()

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

Return

table: A table containing the default properties.