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.
	ChromaticFieldsSetBase (List< double > wavelengths, ChromaticFieldsSetType typeOfChromaticFieldsSet, bool spectrumIsDiscrete)
	standard constructor
override object	Clone ()
	Clones the current object.
override bool	Equals (object otherObject, EqualityIntent equalityIntent)
	Determines whether the specified Object is equal to this instance.
DataArrayBase	GetSumOfAllSubsets ()
	Calculates a DataArray with a single subset containing the sum of all subsets of this.
override string	ToString ()
	overridden to string method of the chromatic fields set class

Properties
override string	FileExtension [get]
	Extension for saved files.
bool	IsDiscreteSpectrum [get, set]
	public property to get and set whether spectrum (stored in CFS) shall be interpreted discrete [true] or continuously [false]
bool	IsOneD [get]
	abstract property to get whether the chromatic fields set is 1D, or 2D
string	PhysicalObjectDescriptionForView [get]
	public property to get the description string for the physical object information in the chromatic fields set view
DataArrayBase	StoredDataSets [get]
	The underlying data as DataArrayBase.
ChromaticFieldsSetType	TypeOfChromaticFieldsSet [get, set]
	Gets or sets what type of chromatic fields set.
override DocumentType	TypeOfDocument [get]
	The type of the document.
List< double >	Wavelengths [get, set]
	Gets and sets the wavelength list of the ChromaticFieldsSet.

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,
		ChromaticFieldsSetType	typeOfChromaticFieldsSet,
		bool	spectrumIsDiscrete
	)

standard constructor

Parameters

wavelengths	the list of wavelength which shall be stores within the ChromaticFieldsSet
typeOfChromaticFieldsSet	additional information of the type of the chromatic fields set
spectrumIsDiscrete	additional information to define whether the wavelengths information within the chromatic fields set shall be interpreted discrete or continuous

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()

DataArrayBase GetSumOfAllSubsets ( )

abstract

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

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.