FarFieldProbe Class

Far Field Probe Class for the API

Inheritance Hierarchy

SystemObject
  ema3d.Api.V25APISimObjectBaseFarFieldProbe
    ema3d.Api.V25.Core.ProbesFDTDProbeBaseFarFieldProbe
      ema3d.Api.V25.Core.ProbesFarFieldProbe

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

Public NotInheritable Class FarFieldProbe
	Inherits FDTDProbeBase(Of FarFieldProbe)

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

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

The FarFieldProbe 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)
	FieldType	Set the field type of the FarFieldProbe
	LocationX	Set the locationX of the FarFieldProbe
	LocationY	Set the locationY of the FarFieldProbe
	LocationZ	Set the locationZ of the FarFieldProbe
	Orientation	Set the Orientation of the FarFieldProbe
	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 FarFieldProbe
	Create	Create a FarFieldProbe
	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 FarFieldProbe objects in the document.
	GetByDisplayName	Get FarFieldProbe 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 FarFieldProbe as FarFieldProbe

_bf = FarFieldProbe.Create(Window.ActiveWindow.Document)
_bf.LocationX = 3.0
_bf.LocationY = 0.3
_bf.LocationZ = 0.6

Reference

ema3d.Api.V25.Core.Probes Namespace