VoltageDifferenceProbe Class

Voltage Difference Probe class for the API

Inheritance Hierarchy

SystemObject
  ema3d.Api.V25APISimObjectBaseVoltageDifferenceProbe
    ema3d.Api.V25.Core.ProbesFDTDProbeBaseVoltageDifferenceProbe
      ema3d.Api.V25.Core.ProbesVoltageDifferenceProbe

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 VoltageDifferenceProbe : FDTDProbeBase<VoltageDifferenceProbe>

Public NotInheritable Class VoltageDifferenceProbe
	Inherits FDTDProbeBase(Of VoltageDifferenceProbe)

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

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

The VoltageDifferenceProbe 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)
	Measure	Gets/Sets end reference location of probe.
	Reference	Gets/Sets start reference location of probe.
	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
	Create	Create a BulkCurrentProbe with ICurvePoint
	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 VoltageDifferenceProbe 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 VoltageDifferenceProbe as VoltageDifferenceProbe

# create a point
point1 = Point.Create(MM(30), MM(30), MM(30))
point2 = Point.Create(MM(0), MM(0), MM(0))
result = SketchCurve.Create(point)
icp = result.CreatedCurves[0].GetChildren[ICurvePoint]()
# Create Curve
_pf = VoltageDifferenceProbe.Create(Window.ActiveWindow.Document,
                                    icp[0], icp[1])

Reference

ema3d.Api.V25.Core.Probes Namespace