Class DataArrayBase

Namespace

VirtualLabAPI.Core.Numerics

Assembly

VirtualLabAPI.dll

Abstract class for storing a map R^M → C^N.

[Serializable]
public abstract class DataArrayBase : DocumentBase, ISerializable, IDeserializationCallback, IDocument, IEquatable<IObjectBase>, ICloneable

Inheritance

object

ObjectBase

SerializableObjectBase

ManualSerialization

DocumentBase

DataArrayBase

Implements

ISerializable

IDeserializationCallback

IDocument

IEquatable<IObjectBase>

ICloneable

Derived

DataArrayGridLess

DataArrayGridded

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Extension Methods

FileHandlingSupport.SaveCompressed(IStorableOnHDD, string, ListOfSavedViewSettings)

Constructors

DataArrayBase()

Standard constructor used for manual serialization

public DataArrayBase()

DataArrayBase(DataArrayBase)

Copy constructor.

public DataArrayBase(DataArrayBase copyDA)

Parameters

copyDA DataArrayBase

Data array which shall be copied.

Properties

AdditionalInformationObject

Gets and sets the additional information to be stored at the data array.

public AdditionalInformationForDataArrays AdditionalInformationObject { get; set; }

Property Value

AdditionalInformationForDataArrays

CommentsOfDataEntries

Gets and sets the comment for each dimension in C^N.

public abstract string[] CommentsOfDataEntries { get; set; }

Property Value

string[]

DataArrayType

Abstract property to get the data array type for the derived class.

public abstract DataArrayType DataArrayType { get; }

Property Value

DataArrayType

DimensionalityOfCoordinates

Dimensionality M of the space of independent variables R^M.

public abstract int DimensionalityOfCoordinates { get; }

Property Value

int

DimensionalityOfData

Dimensionality N of the space of data values C^N.

public abstract int DimensionalityOfData { get; }

Property Value

int

GraphicsAddons

The graphics add-on data to be drawn.

public GraphicsAddOnData GraphicsAddons { get; set; }

Property Value

GraphicsAddOnData

IsComplex

Are the values defined in C^N (true) or in the subset of real numbers R^N (false).

public abstract bool IsComplex { get; }

Property Value

bool

MeasuredQuantitiesOfDataEntries

Gets and sets the measured quantity for each dimension in C^N.

public MeasuredQuantity[] MeasuredQuantitiesOfDataEntries { get; set; }

Property Value

MeasuredQuantity[]

NoSmoothingInterpolationMethod

Gets a flag indicating whether or not none of the interpolation methods is smoothing (like nearest neighbor or constant interval; true). But if one of the methods does (like all other methods), the flag is set to false.

public abstract bool NoSmoothingInterpolationMethod { get; }

Property Value

bool

PhysicalMeaning

Gets and sets the physical meaning of the data array object (default: None).

public PhysicalMeaning PhysicalMeaning { get; set; }

Property Value

PhysicalMeaning

TypeOfDocument

Gets the type of the document.

public override DocumentType TypeOfDocument { get; }

Property Value

DocumentType

Methods

Clone()

Clones the current object.

public override object Clone()

Returns

object

Deep copy of this object.

Equals(object?, EqualityIntent)

Checks if two DataArrayBase objects are equal.

public override bool Equals(object? obj, EqualityIntent equalityIntent)

Parameters

obj object

equalityIntent EqualityIntent

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

Returns

bool

True if the object is equal to this.

GetDataForSubset(int)

Gets the data for the given subset index.

public abstract ComplexField GetDataForSubset(int subsetIndex)

Parameters

subsetIndex int

The index of the subset.

Returns

ComplexField

The ComplexField with the data for the given subset.

GetHashCode()

Serves as the default hash function.

public override int GetHashCode()

Returns

int

A hash code for the current object.

HeaderInformation(int, TextExportImportSettings, FieldQuantity?)

Public method to get the export header (data meaning and sampling parameters) for a specific data array.

public virtual string HeaderInformation(int subSetID, TextExportImportSettings exportSettings, FieldQuantity? quantityForInformation = null)

Parameters

subSetID int

The ID of the subset for which the header information shall be extracted.

exportSettings TextExportImportSettings

The text export settings (header indicator, decimal separator and so on).

quantityForInformation FieldQuantity?

Optional FieldQuantity for which the header information shall be generated.

Returns

string

The export header string for the subset within the DataArray which has the subSetID.

SetDataWithPropertiesAndCommentsAtOnce(ComplexField[], MeasuredQuantity[], string[])

Sets the members Data, MeasuredQuantitiesOfDataEntries and CommentsOfDataEntries at once to ensure consistency.

public abstract void SetDataWithPropertiesAndCommentsAtOnce(ComplexField[] data, MeasuredQuantity[] measuredQuantitiesOfDataEntries, string[] commentsOfDataEntries)

Parameters

data ComplexField[]

Data to set.

measuredQuantitiesOfDataEntries MeasuredQuantity[]

MeasuredQuantitiesOfDataEntries to set.

commentsOfDataEntries string[]

CommentsOfDataEntries to set.

ToString()

Returns the string description of the data array.

public override string ToString()

Returns

string

The string description of the data array.