ShieldDefinition Class

An MHARNESS Conductor Definition

Inheritance Hierarchy

SystemObject
ema3d.Api.V25APISimObjectBaseShieldDefinition
ema3d.Api.V25.Cabling.DefinitionsShieldDefinition

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

Syntax

C++

Copy

public sealed class ShieldDefinition : APISimObjectBase<ShieldDefinition>, 
	IShieldDefinition, IConductorDefinition, ICableDefinition

Public NotInheritable Class ShieldDefinition
	Inherits APISimObjectBase(Of ShieldDefinition)
	Implements IShieldDefinition, IConductorDefinition, ICableDefinition

public ref class ShieldDefinition sealed : public APISimObjectBase<ShieldDefinition^>, 
	IShieldDefinition, IConductorDefinition, ICableDefinition

[<SealedAttribute>]
type ShieldDefinition = 
    class
        inherit APISimObjectBase<ShieldDefinition>
        interface IShieldDefinition
        interface IConductorDefinition
        interface ICableDefinition
    end

The ShieldDefinition type exposes the following members.

Properties

	Name	Description
	Conductivity	Gets/Sets conductivity of the conductor (in Siemens/m) (Only applies when HasSkinDepthEffects = true).
	DisplayName	Gets/Sets the display name of the underlying sim object. (Inherited from APISimObjectBaseTWrapper)
	FillerDielectric	Gets/Sets filler/background dielectric of the shield.
	FillerDisplayColor	Gets/Sets filler/background display color of the shield.
	FillerThickness	Gets/Sets filler/background thickness of the shield.
	HasSkinDepthEffects	Gets/Sets if conductor has skin depth effects.
	IsTwisted	Gets/Sets if the contents of this item should be twisted.
	Jacket	Gets/Sets the conductor's dielectric jacket
	Pitch	Gets/Sets pitch of contents twist (twists/m).
	Radius	Gets/Sets inner radius of the conductor (in m)
	Shape	Gets/Sets shape of conductor (Circular, Ellipse, Polygon)
	SignalID
	Thickness	Gets/Sets thickness of the conductor (only applies when HasSkinDepthEffects = true).
	Vertices	Gets/Sets vertices of polygonal conductor
	XRadius	Gets/Sets XRadius of elliptical conductor
	YRadius	Gets/Sets YRadius of elliptical conductor

Top

Methods

	Name	Description
	Copy	Create a copy of the Conductor Definition
	Create	Create a new ShieldDefinition 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 ShieldDefinition 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

Example

Python

Copy

import ema3d.Api.V25.Cabling.Definitions as Definitions
# Create new shield definition
_sdef = Definitions.ShieldDefinition.Create()
_sdef.Resistance = 0.004
_sdef.Radius = 0.0029
_sdef.Jacket.Dielectric = 1.8

Reference

ema3d.Api.V25.Cabling.Definitions Namespace