ConductorDefinition Class

An MHARNESS Conductor Definition

Inheritance Hierarchy

SystemObject
ema3d.Api.V25APISimObjectBaseConductorDefinition
ema3d.Api.V25.Cabling.DefinitionsConductorDefinition

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 ConductorDefinition : APISimObjectBase<ConductorDefinition>, 
	IConductorDefinition, ICableDefinition

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

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

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

The ConductorDefinition 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)
	HasSkinDepthEffects	Gets/Sets if conductor has skin depth effects.
	Jacket	Gets/Sets the conductor's dielectric jacket
	Radius	Gets/Sets inner radius of the conductor (in m)
	Resistance	Gets/Sets resistance of the conductor (in Ohms/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 ConductorDefinition 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 ConductorDefinition 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 conductor definition
_cdef = Definitions.ConductorDefinition.Create()
_cdef.Radius = 0.002
_cdef.HasSkinDepthEffects = True
_cdef.Conductivity = 2.5e7
_cdef.Thickness = 0.002

Reference

ema3d.Api.V25.Cabling.Definitions Namespace