FieldProbeT Class

Field Probe Abstract Class for the API

Inheritance Hierarchy

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

Syntax

public abstract class FieldProbe<T> : FDTDProbeBase<T>
where T : FieldProbe<T>

Public MustInherit Class FieldProbe(Of T As FieldProbe(Of T))
	Inherits FDTDProbeBase(Of T)

generic<typename T>
where T : FieldProbe<T>
public ref class FieldProbe abstract : public FDTDProbeBase<T>

[<AbstractClassAttribute>]
type FieldProbe<'T when 'T : FieldProbe<'T>> = 
    class
        inherit FDTDProbeBase<'T>
    end

The FieldProbeT 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)
	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

Methods

	Name	Description
	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.
	Delete	Deletes sim object. (Inherited from APISimObjectBaseTWrapper)
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object)
	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. (Inherited from APISimObjectBaseTWrapper)
	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)