FieldRepresentationObject Class Reference

This class is subject to change. Programs using this class may require changes with a new version of VirtualLab.
Abstract base class for all field representations. More...

Inheritance diagram for FieldRepresentationObject:

Public Member Functions
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
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.
Abstract base class for all field representations.

Constructor & Destructor Documentation

FieldRepresentationObject() [1/2]

FieldRepresentationObject

(

FieldRepresentationObject

fro

)

Copy constructor.

Parameters

fro	Field representation object to copy.

FieldRepresentationObject() [2/2]

FieldRepresentationObject	(	SerializationInfo	info,
		StreamingContext	context
	)

Deserialization constructor. See the ISerializable interface for more details.

Parameters

info	SerializationInfo
context	StreamingContext

Member Function Documentation

Clone()

override object Clone

(

)

Clones the current object.

Returns

Deep copy of this object.

Equals()

override bool Equals	(	object	otherObject,
		EqualityIntent	equalityIntent
	)

Determines whether the specified Object is equal to this instance.

Parameters

otherObject	The Object to compare with this instance.
equalityIntent	Defines what kind of equality you want to check when comparing two objects, for example all values or just physical equality.

Returns

true if the specified Object is equal to this instance; otherwise, false.

Save()

abstract void Save ( string  filename )

pure virtual

Implementation of the IDocument Save function.

Parameters

filename

Path and file name.

Implemented in ComplexAmplitude, and HarmonicFieldsSet.

Property Documentation

FieldRepresentation

abstract FieldRepresentation FieldRepresentation

get

Get field representation.

Returns

FileExtension

abstract string FileExtension

get

File extension

Returns