ChromaticFieldsSetBase 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 a Chromatic Fields Set (can be 1D or 2D) More...

Inheritance diagram for ChromaticFieldsSetBase:

Public Member Functions
	ChromaticFieldsSetBase (ChromaticFieldsSetBase chromaticFieldsSet)
	Copy constructor More...
	ChromaticFieldsSetBase (List< double > wavelengths)
	standard constructor More...
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...
abstract DataArrayBase	GetSumOfAllSubsets ()
	Calculates a DataArray with a single subset containing the sum of all subsets of this More...
void	Reload ()
	Reload method for this document
void	Save (string fileName)
	Save method More...
override string	ToString ()
	overridden to string method of the chromatic fields set class More...
void	Reload ()
	Reload function for the document

Properties
string	FileExtension [get]
	Extension for saved files
bool	IsOneD [get]
	abstract property to get whether the chromatic fields set is 1D, or 2D
VirtualLabSession	Session [get, set]
	public property to set and get the session where the document belongs to
abstract DataArrayBase	StoredDataSets [get]
	The underlying data as DataArrayBase.
NodeVLExplorer	TreeStructure [get]
	property to get the node structure for the VirtualLab Explorer
virtual ChromaticFieldsSetType	TypeOfChromaticFieldsSet [get]
	Gets or sets what type of chromatic fields set this is
DocumentType	TypeOfDocument [get]
	The type of the document.
List< double >	Wavelengths [get, set]
	Gets and sets the wavelength list of the ChromaticFieldsSet More...
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 a Chromatic Fields Set (can be 1D or 2D)

Constructor & Destructor Documentation

ChromaticFieldsSetBase() [1/2]

ChromaticFieldsSetBase

(

List< double >

wavelengths

)

standard constructor

Parameters

wavelengths

the list of wavelength which shall be stores within the ChromaticFieldsSet

ChromaticFieldsSetBase() [2/2]

ChromaticFieldsSetBase

(

ChromaticFieldsSetBase

chromaticFieldsSet

)

Copy constructor

Parameters

chromaticFieldsSet

ChromaticFieldsSetBase to copy

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.

GetSumOfAllSubsets()

abstract DataArrayBase GetSumOfAllSubsets ( )

pure virtual

Calculates a DataArray with a single subset containing the sum of all subsets of this

Returns

DataArray with a single subset containing the sum of all subsets of this

Implemented in ChromaticFieldsSet, and ChromaticFieldsSet_1D.

Save()

void Save

(

string

fileName

)

Save method

Parameters

fileName

ToString()

override string ToString

(

)

overridden to string method of the chromatic fields set class

Returns

the string description of the chromatic fields set class

Property Documentation

Wavelengths

List<double> Wavelengths

getset

Gets and sets the wavelength list of the ChromaticFieldsSet