BoxFieldProbe Class

Box Field Probe class for the API

Inheritance Hierarchy

SystemObject
  ema3d.Api.V25APISimObjectBaseBoxFieldProbe
    ema3d.Api.V25.Core.ProbesFDTDProbeBaseBoxFieldProbe
      ema3d.Api.V25.Core.ProbesFieldProbeBoxFieldProbe
        ema3d.Api.V25.Core.ProbesBoxFieldProbe

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

Syntax

C++

Copy

public class BoxFieldProbe : FieldProbe<BoxFieldProbe>

Public Class BoxFieldProbe
	Inherits FieldProbe(Of BoxFieldProbe)

public ref class BoxFieldProbe : public FieldProbe<BoxFieldProbe^>

type BoxFieldProbe = 
    class
        inherit FieldProbe<BoxFieldProbe>
    end

The BoxFieldProbe type exposes the following members.

Properties

	Name	Description
	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
	MaxSamples	Gets / Sets the maximum number of sample counts allowed
	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
	TEnd	Gets/Sets end time. (Inherited from FDTDProbeBaseT)
	TStart	Gets/Sets start time. (Inherited from FDTDProbeBaseT)
	TStep	Gets/Sets time step. (Inherited from FDTDProbeBaseT)
	Type	Gets / Sets the type of field to the probe (Inherited from FieldProbeT)

Top

Methods

	Name	Description
	Clone	Clone the intance of a BoxFieldProbe
	ComputeFieldStastistics	Gets the most recent Field Probe Result and computes the field statistics, then plots the result in the sim tree. If there are multiple Field probes, make sure to have unique display name, otherwise there could be issues with grabbing the correct result due to there not being a refrence to the origonal field probe in the field probe result. (Inherited from FieldProbeT)
	Create(Document, ICurvePoint, ICurvePoint)	Create a BoxFieldProbe 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 BoxFieldProbe 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 BoxFieldProbe as BoxFieldProbe
from ema3d.Api.V25.Core import FieldType as FieldType
from ema3d.Api.V25.Core import DomainDependentDouble as DomainDependentDouble
_bf = BoxFieldProbe.Create(Window.ActiveWindow.Document,
                           0.0, 0.0, 0.0,
                           0.3, 0.3, 0.3)
_bf.TStep = DomainDependentDouble(1e-8, ema3d.Api.V25.Core.MatchDomainType.None)
_bf.MaxSamples = 64
_bf.FieldType = FieldType.Magnetic

Reference

ema3d.Api.V25.Core.Probes Namespace