Table of Contents

Class ChromaticFieldsSet_1D

Namespace
VirtualLabAPI.Core.FieldRepresentations
Assembly
VirtualLabAPI.dll

Class for a one-dimensional Chromatic Fields Set.

[Serializable]
public class ChromaticFieldsSet_1D : ChromaticFieldsSetBase, ISerializable, IDeserializationCallback, IDocument, IEquatable<IObjectBase>, ICloneable
Inheritance
ObjectBase
SerializableObjectBase
ManualSerialization
DocumentBase
ChromaticFieldsSet_1D
Implements
IEquatable<IObjectBase>
Inherited Members
Extension Methods

Constructors

ChromaticFieldsSet_1D(ChromaticFieldsSet_1D)

Copy constructor

public ChromaticFieldsSet_1D(ChromaticFieldsSet_1D chromaticFieldsSet)

Parameters

chromaticFieldsSet ChromaticFieldsSet_1D

ChromaticFieldsSet to copy

ChromaticFieldsSet_1D(DataArray1D, List<double>, ChromaticFieldsSetType, bool)

standard constructor

public ChromaticFieldsSet_1D(DataArray1D datasets, List<double> wavelengths, ChromaticFieldsSetType typeOfChromaticFieldsSet = ChromaticFieldsSetType.Unspecified, bool spectrumIsDiscrete = true)

Parameters

datasets DataArray1D

the dataset which shall be stores within the ChromaticFieldsSet

wavelengths List<double>

the list of wavelength which shall be stores within the ChromaticFieldsSet

typeOfChromaticFieldsSet ChromaticFieldsSetType

additional information of the type of the chromatic fields set

spectrumIsDiscrete bool

additional information to define whether the wavelengths information within the chromatic fields set shall be interpreted discrete or continuous

Properties

Stored1DDataSets

public get property for the internal stored DataArray1D

public virtual DataArray1D Stored1DDataSets { get; }

Property Value

DataArray1D

StoredDataSets

The underlying data as DataArrayBase.

public override DataArrayBase StoredDataSets { get; }

Property Value

DataArrayBase

Methods

Clone()

Deep copy

public override object Clone()

Returns

object

Deep copy of this

Equals(object, EqualityIntent)

Determines whether the specified object is equal to this instance.

public override bool Equals(object otherObject, EqualityIntent equalityIntent)

Parameters

otherObject object

The object to compare with this instance.

equalityIntent EqualityIntent

Defines what kind of equality you want to check when comparing two objects, for example all values or just physical equality.

Returns

bool

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

GetNewDocumentWindow(Form, string)

Gets a new document window containing this document.

public override FormDocument GetNewDocumentWindow(Form formMain, string fileName)

Parameters

formMain Form

Reference to the main form (= MDI parent). Can be null if this form will not be shown (e.g. if it is generated just to get the view settings.

fileName string

File name from which the document was opened for inserting into window caption. If this string is empty, the default document name is used.

Returns

FormDocument

A VirtualLabAPI.UI.BasicUI.FormDocument containing this document.

GetSumOfAllSubsets()

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

public override DataArrayBase GetSumOfAllSubsets()

Returns

DataArrayBase

DataArrayBase with a single subset containing the sum of all subsets of this.

Load(string)

Loads the specified file name. Works independently from whether the document has been saved without view settings (as prior to VirtualLab 6.0) or with view settings.

public static ChromaticFieldsSet_1D Load(string fileName)

Parameters

fileName string

Name of the file.

Returns

ChromaticFieldsSet_1D

The specified document.

ToString()

overridden to string method of the chromatic fields set class

public override string ToString()

Returns

string

the string description of the chromatic fields set class