Shield Class

An individual shield in a cable harness.

Inheritance Hierarchy

SystemObject
ema3d.Api.V25APISimObjectBaseShield
ema3d.Api.V25.CablingShield

Namespace: ema3d.Api.V25.Cabling
Assembly: ema3d.Api.V25 (in ema3d.Api.V25.dll) Version: 0.0.0.0

Syntax

C++

Copy

public sealed class Shield : APISimObjectBase<Shield>, 
	IAPICable, IAPISimObject, IHasRouting, IHasShieldDefinition, IHasCableDefinition

Public NotInheritable Class Shield
	Inherits APISimObjectBase(Of Shield)
	Implements IAPICable, IAPISimObject, IHasRouting, IHasShieldDefinition, 
	IHasCableDefinition

public ref class Shield sealed : public APISimObjectBase<Shield^>, 
	IAPICable, IAPISimObject, IHasRouting, IHasShieldDefinition, IHasCableDefinition

[<SealedAttribute>]
type Shield = 
    class
        inherit APISimObjectBase<Shield>
        interface IAPICable
        interface IAPISimObject
        interface IHasRouting
        interface IHasShieldDefinition
        interface IHasCableDefinition
    end

The Shield type exposes the following members.

Properties

	Name	Description
	Definition	Gets/Sets the definition of this shield
	DisplayName	Gets/Sets the display name of the underlying sim object. (Inherited from APISimObjectBaseTWrapper)
	Routing	The routing associated with a particular routed element.

Top

Methods

	Name	Description
	Create	Create a new Shield in the document.
	Delete	Deletes sim object. (Inherited from APISimObjectBaseTWrapper)
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object)
	GetAll	Retrieve all Shield objects in the document.
	GetHashCode	Serves as the default hash function. (Inherited from Object)
	GetName	Returns the name of the object. (Inherited from APISimObjectBaseTWrapper)
	GetSiblings	Get all objects that share this object's type in the document. (Overrides APISimObjectBaseTWrapperGetSiblings(Document))
	GetType	Gets the Type of the current instance. (Inherited from Object)
	SetName	Sets the name of the object (Inherited from APISimObjectBaseTWrapper)
	SetVisibility	Sets the visibility status of the object. (Inherited from APISimObjectBaseTWrapper)
	ToString	Returns a string that represents the current object. (Inherited from Object)

Top

Remarks

Shields can have child elements nested within their topology.

Example

Python

Copy

from ema3d.Api.V25.Cabling import Shield as Shield
# Get all Shields, access routing
_shields = Shield.GetAll()
_s1routing = _shields[0].Routing

Reference

ema3d.Api.V25.Cabling Namespace