FieldProbeResult Class

An EMC Plus Field Probe Result object.

Inheritance Hierarchy

SystemObject
ema3d.Api.V25APISimObjectBaseFieldProbeResult
ema3d.Api.V25.ResultsFieldProbeResult

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

Syntax

C++

Copy

public sealed class FieldProbeResult : APISimObjectBase<FieldProbeResult>

Public NotInheritable Class FieldProbeResult
	Inherits APISimObjectBase(Of FieldProbeResult)

public ref class FieldProbeResult sealed : public APISimObjectBase<FieldProbeResult^>

[<SealedAttribute>]
type FieldProbeResult = 
    class
        inherit APISimObjectBase<FieldProbeResult>
    end

The FieldProbeResult type exposes the following members.

Properties

	Name	Description
	Bounds	Gets the bounding Box for this field probe.
	DisplayName	Gets/Sets the display name of the underlying sim object. (Inherited from APISimObjectBaseTWrapper)

Top

Methods

	Name	Description
	CalculateFieldStatistics	Calculate Field Statistics from this probe object.
	CalculateShieldingEffectiveness(ISignal)	Calculates the shielding effectiveness transfer function from this field probe result and a signal object in the EMC Plus document.
	CalculateShieldingEffectiveness(String)	Calculates the shielding effectiveness transfer function from this field probe result and path to a source file waveform
	CalculateShieldingEffectiveness(FieldProbeResult, ISignal)	Calculates the shielding effectiveness transfer function from a field probe result and a signal object in the EMC Plus document.
	CalculateShieldingEffectiveness(FieldProbeResult, String)	Calculates the shielding effectiveness transfer function from a field probe result and path to a source file waveform
	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 FieldProbeResult objects in the document.
	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

Remarks

These objects contain metadata and information for calculating field probe statistics and transfer functions.

Reference

ema3d.Api.V25.Results Namespace