BulkCurrentProbe Class

Bulk Current Probe class for the API

Inheritance Hierarchy

SystemObject
  ema3d.Api.V25APISimObjectBaseBulkCurrentProbe
    ema3d.Api.V25.Core.ProbesFDTDProbeBaseBulkCurrentProbe
      ema3d.Api.V25.Core.ProbesBulkCurrentProbe

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

Syntax

C++

Copy

public sealed class BulkCurrentProbe : FDTDProbeBase<BulkCurrentProbe>

Public NotInheritable Class BulkCurrentProbe
	Inherits FDTDProbeBase(Of BulkCurrentProbe)

public ref class BulkCurrentProbe sealed : public FDTDProbeBase<BulkCurrentProbe^>

[<SealedAttribute>]
type BulkCurrentProbe = 
    class
        inherit FDTDProbeBase<BulkCurrentProbe>
    end

The BulkCurrentProbe type exposes the following members.

Properties

	Name	Description
	CurrentType	Gets/Sets the type of current represented in the probe.
	DisplayName	Gets/Sets the display name of the underlying sim object. (Inherited from APISimObjectBaseTWrapper)
	Document	The document an object exists in. (Inherited from FDTDProbeBaseT)
	MaximumX	Gets/Sets maximum corner of probed region in the X-direction
	MaximumY	Gets/Sets maximum corner of probed region in the Y-direction
	MaximumZ	Gets/Sets maximum corner of probed region in the Z-direction
	MinimumX	Gets/Sets minimum corner of probed region in the X-direction
	MinimumY	Gets/Sets minimum corner of probed region in the Y-direction
	MinimumZ	Gets/Sets minimum corner of probed region in the Z-direction
	NormalDirection	Gets/Sets the normal direction to the integration surface of the Bulk Current Probe.
	Skip	Gets/Sets the number of cells between each integration surface.
	TEnd	Gets/Sets end time. (Inherited from FDTDProbeBaseT)
	TStart	Gets/Sets start time. (Inherited from FDTDProbeBaseT)
	TStep	Gets/Sets time step. (Inherited from FDTDProbeBaseT)

Top

Methods

	Name	Description
	Clone	Clone the intance of a BulkCurrentProbe
	Create(Document, ICurvePoint, ICurvePoint)	Create a BulkCurrentProbe with ICurvePoint
	Create(Document, Double, Double, Double, Double, Double, Double)	Create a BoxFieldProbe with doubles
	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 BulkCurrentProbe objects in the document.
	GetByDisplayName	Get BoxFieldProbe 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.Probes import BulkCurrentProbe as BulkCurrentProbe
from ema3d.Api.V25.Core import FieldType as FieldType

_bf = BulkCurrentProbe.Create(Window.ActiveWindow.Document,
                           0.0, 0.0, 0.0,
                           0.3, 0.3, 0.3)
_bf.TStep = 1e-8
_bf.Skip = 2
_bf.FieldType = FieldType.Magnetic

Reference

ema3d.Api.V25.Core.Probes Namespace