CurrentDensity Class

CurrentDensity API Class

Inheritance Hierarchy

SystemObject
  ema3d.Api.V25APISimObjectBaseCurrentDensity
    ema3d.Api.V25.Core.ExcitationExcitationBaseCurrentDensity
      ema3d.Api.V25.Core.ExcitationCurrentDensity

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

Syntax

C++

Copy

public sealed class CurrentDensity : ExcitationBase<CurrentDensity>

Public NotInheritable Class CurrentDensity
	Inherits ExcitationBase(Of CurrentDensity)

public ref class CurrentDensity sealed : public ExcitationBase<CurrentDensity^>

[<SealedAttribute>]
type CurrentDensity = 
    class
        inherit ExcitationBase<CurrentDensity>
    end

The CurrentDensity type exposes the following members.

Properties

	Name	Description
	CurrentType	Gets / Sets the type of current to use with the source
	DisplayName	Gets/Sets the display name of the underlying sim object. (Inherited from APISimObjectBaseTWrapper)
	Document	The document an object exists in. (Inherited from ExcitationBaseT)
	Geometry	Gets / Sets geometry that the source is attached to
	IsReversed	Gets / Sets if the current direction should be reversed with respect to the line
	Simulation	The Simulation an object exists in. (Inherited from ExcitationBaseT)

Top

Methods

	Name	Description
	Create	Gets the current density instance in a document or creates one if it does not exist.
	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 CurrentDensity objects in the document.
	GetByDisplayName	Get CurrentDensity by display name
	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

from ema3d.Api.V25.Core.Excitation import CurrentDensity as CurrentDensity
from ema3d.Api.V25.Core.Excitation import CurrentDensityType as CurrentDensityType

# Set Sketch Plane
result = ViewHelper.SetSketchPlane(Plane.PlaneXY)
# Sketch Rectangle
point1 = Point2D.Create(MM(-10),MM(-10))
point2 = Point2D.Create(MM(10),MM(-10))
point3 = Point2D.Create(MM(10),MM(10))
result = SketchRectangle.Create(point1, point2, point3)
# Solidify Sketch
result = ViewHelper.SetViewMode(InteractionMode.Solid)
_face = result.GetCreated[IDesignBody]()[0].Faces[0]

# Create CurrentDensity source
_cd = CurrentDensity.Create(_face)
_cd.DisplayName = "Test Current Density Source"
_cd.CurrentType = CurrentDensityType.Magnetic

Reference

ema3d.Api.V25.Core.Excitation Namespace