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
	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. More...

	HarmonicFieldBase (SerializationInfo info, StreamingContext context)
	Deserialization constructor to initialize new instance of the HarmonicFieldBase class. More...

abstract void	RemoveSphericalPhaseFactor ()
	Removes the Spherical Phase Factor(s) from the field.

Public Member Functions inherited from FieldRepresentationObject
override object	Clone ()
	Clones the current object. More...

override bool	Equals (object otherObject, EqualityIntent equalityIntent)
	Determines whether the specified Object is equal to this instance. More...

	FieldRepresentationObject ()
	Standard constructor.

	FieldRepresentationObject (FieldRepresentationObject fro)
	Copy constructor. More...

	FieldRepresentationObject (SerializationInfo info, StreamingContext context)
	Deserialization constructor. See the ISerializable interface for more details. More...

abstract void	Save (string filename)
	Implementation of the IDocument Save function. More...

Public Member Functions inherited from IDocument
void	Reload ()
	Reload function for the document

Properties
abstract bool	IsSpatial `[get, set]`
	Gets and sets whether the field is in spatial domain (if `true`) or spectral domain (if `false`).

Properties inherited from FieldRepresentationObject
OpticalSystems.HomogeneousMedium	EmbeddingMedium `[get, set]`
	Medium the light field object is located in

abstract FieldRepresentation	FieldRepresentation `[get]`
	Get field representation. More...

abstract string	FileExtension `[get]`
	File extension More...

abstract DocumentType	TypeOfDocument `[get]`
	The type of the document.

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.

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ HarmonicFieldBase() [1/2]

◆ HarmonicFieldBase() [2/2]