PlaneWave Class

A Plane Wave instance in EMC Plus.

Only one instance of a Plane Wave can exist in a document. Multiple API Plane Wave instances can be created, but changes to any will reflect on the singleton document instance.

Inheritance Hierarchy

SystemObject
  ema3d.Api.V25APISimObjectBasePlaneWave
    ema3d.Api.V25.Core.ExcitationExcitationBasePlaneWave
      ema3d.Api.V25.Core.ExcitationPlaneWave

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

Syntax

C++

Copy

public sealed class PlaneWave : ExcitationBase<PlaneWave>

Public NotInheritable Class PlaneWave
	Inherits ExcitationBase(Of PlaneWave)

public ref class PlaneWave sealed : public ExcitationBase<PlaneWave^>

[<SealedAttribute>]
type PlaneWave = 
    class
        inherit ExcitationBase<PlaneWave>
    end

The PlaneWave type exposes the following members.

Properties

	Name	Description
	Alpha	Gets/Sets the polar angle of the plane wave electric field vector (from z axis).
	Beta	Gets/Sets the azimuthal angle of the plane wave electric vector (from x axis).
	DisplayName	Gets/Sets the display name of the underlying sim object. (Inherited from APISimObjectBaseTWrapper)
	Document	The document an object exists in. (Inherited from ExcitationBaseT)
	Phi	Gets/Sets the polar angle of the plane wave incident vector (from x axis).
	Simulation	The Simulation an object exists in. (Inherited from ExcitationBaseT)
	Theta	Gets/Sets the azimuthal angle of the plane wave incident vector (from z axis).

Top

Methods

	Name	Description
	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 PlaneWave objects in the document.
	GetHashCode	Serves as the default hash function. (Inherited from Object)
	GetInstance	Gets the plane wave instance in a document or creates one if it does not exist.
	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.Excitation import PlaneWave as PlaneWave

# Get plane wave instance
_pw = PlaneWave.GetInstance()
_pw.DisplayName = "Plane Wave Instance"
# Set polarization parameters. NOTE: Orthogonalization occurs after each setter
_pw.Alpha = 1.5708
_pw.Beta = 1.5708

Reference

ema3d.Api.V25.Core.Excitation Namespace