AntennaFarFieldProbe Class

AntennaFarFieldProbe class for the API

Inheritance Hierarchy

SystemObject
  ema3d.Api.V25APISimObjectBaseAntennaProbe
    ema3d.Api.V25.Core.ProbesFDTDProbeBaseAntennaProbe
      ema3d.Api.V25.Core.ProbesFieldProbeAntennaProbe
        ema3d.Api.V25.Core.ProbesAntennaFarFieldProbe

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 AntennaFarFieldProbe : FieldProbe<AntennaProbe>

Public NotInheritable Class AntennaFarFieldProbe
	Inherits FieldProbe(Of AntennaProbe)

public ref class AntennaFarFieldProbe sealed : public FieldProbe<AntennaProbe^>

[<SealedAttribute>]
type AntennaFarFieldProbe = 
    class
        inherit FieldProbe<AntennaProbe>
    end

The AntennaFarFieldProbe 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)
	FrequencyEnd	Gets/Sets the frequency end of the Antenna Probe
	FrequencyStart	Gets/Sets the frequency start of the Antenna Probe
	FrequencyStep	Gets/Sets the frequency step of the Antenna Probe
	MaximumX	Gets/Sets maximum x-value for corner of probed region.
	MaximumY	Gets/Sets maximum y-value for corner of probed region.
	MaximumZ	Gets/Sets maximum z-value for corner of probed region.
	MinimumX	Gets/Sets minimum x-value for corner of probed region.
	MinimumY	Gets/Sets minimum y-value for corner of probed region.
	MinimumZ	Gets/Sets minimum z-value for corner of probed region.
	PhiEnd	Gets/Sets the phi end of the Antenna Probe
	PhiStart	Gets/Sets the phi start of the Antenna Probe
	PhiStep	Gets/Sets the phi step of the Antenna Probe
	ResultDimension	Gets/Sets whether to simulate on full sphere or not.
	ResultDomain	Gets/Sets the antenna probe solver algorithm
	TEnd	Gets/Sets end time. (Inherited from FDTDProbeBaseT)
	ThetaEnd	Gets/Sets the theta end of the Antenna Probe
	ThetaStart	Gets/Sets the theta start of the Antenna Probe
	ThetaStep	Gets/Sets the theta step of the Antenna Probe
	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 AntennaFarFieldProbe
	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	Create a new AntennaFarFieldProbe.
	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 AntennaFarFieldProbe objects in the document.
	GetByDisplayName	Get Antenna Far Field Probe 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 AntennaFarFieldProbe as AntennaFarFieldProbe
from ema3d.Api.V25.Core.Probes import AntennaResultsDimension as AntennaResultsDimension
from ema3d.Api.V25.Core.Probes import AntennaResultsDomain as AntennaResultsDomain
# Create probe
_aff = AntennaFarFieldProbe.Create()
_aff.DisplayName = "AntennaFarFieldProbe"
_aff.ResultDimension = AntennaResultsDimension.Sphere
_aff.ResultDomain = AntennaResultsDomain.Frequency

Reference

ema3d.Api.V25.Core.Probes Namespace