HarmonicFieldBase Class Reference

This class is subject to change. Programs using this class may require changes with a new version of VirtualLab.
Base class for Harmonic Fields and Harmonic Fields Sets. More...

Inheritance diagram for HarmonicFieldBase:

Public Member Functions
IEnumerable< ComplexAmplitude >	GetFields ()
	Gets all member fields in the harmonic field.
	HarmonicFieldBase ()
	Default constructor to initialize a new instance of the HarmonicFieldBase class.
	HarmonicFieldBase (HarmonicFieldBase field)
	Copy constructor to initialize a new instance of the HarmonicFieldBase class.
	HarmonicFieldBase (SerializationInfo info, StreamingContext context)
	Deserialization constructor to initialize new instance of the HarmonicFieldBase class.
void	RemoveSphericalPhaseFactor (CancellationToken? cancellationToken=null)
	Removes the Spherical Phase Factor(s) from the field.
Public Member Functions inherited from IDocument
FormDocument	GetNewDocumentWindow (Form formMain, string fileName)
	Gets a new document window containing this document.

Properties
bool	IsSpatial [get, set]
	Gets and sets whether the field is in spatial domain (if true) or spectral domain (if false).
bool	PropagatesInPositiveZDirection [get, set]
	Gets or sets whether the sign of the z-component of the k-vector is positive or not.
Properties inherited from IDocument
VirtualLabSession	Session [get, set]
	every documents need to be handled in a session ==> default is the VirtualLab Mainsession
NodeVLExplorer	TreeStructure [get]
	every document should have a node (maybe with subnodes) in the VirtualLab Explorer
DocumentType	TypeOfDocument [get]
	Gets an enum entry specifying the type of the document.

Detailed Description

This class is subject to change. Programs using this class may require changes with a new version of VirtualLab.
Base class for Harmonic Fields and Harmonic Fields Sets.

See also

VirtualLabAPI.Core.FieldRepresentations.FieldRepresentationObject

Constructor & Destructor Documentation

HarmonicFieldBase() [1/2]

HarmonicFieldBase

(

HarmonicFieldBase

field

)

Copy constructor to initialize a new instance of the HarmonicFieldBase class.

Parameters

field

The field to copy.

HarmonicFieldBase() [2/2]

HarmonicFieldBase	(	SerializationInfo	info,
		StreamingContext	context )

Deserialization constructor to initialize new instance of the HarmonicFieldBase class.

Parameters

info	The serialization information.
context	The serialization context.

Member Function Documentation

GetFields()

IEnumerable< ComplexAmplitude > GetFields ( )

abstract

Gets all member fields in the harmonic field.

Returns

Collection of the member fields.

RemoveSphericalPhaseFactor()

void RemoveSphericalPhaseFactor ( CancellationToken? cancellationToken = null )

abstract

Removes the Spherical Phase Factor(s) from the field.

Parameters

cancellationToken

Optional token for cooperative task cancellation.