Programming Reference for VirtualLab Fusion  2025.1
Loading...
Searching...
No Matches
DataArrayBase Class Referenceabstract

This class is subject to change. Programs using this class may require changes with a new version of VirtualLab.
Abstract class for storing a map R^M → C^N More...

Inheritance diagram for DataArrayBase:
DataArrayGridLess

Public Member Functions

 DataArrayBase ()
 Standard constructor used for manual serialization.
 
 DataArrayBase (DataArrayBase copyDA)
 copy constructor
 

Static Public Attributes

static string AdditionalInfoName_SingleWavelength
 Key to be used in the additional information list in order to identify a single wavelength which applies to all subsets.
 
static string AdditionalInfoName_WavelengthPerSubset
 Key to be used in the additional information list in order to identify an array of wavelengths where every value applies to one subset.
 

Properties

Dictionary< string, object > AdditionalInformation [get, set]
 Additional information to be stored at the data array.
 
AdditionalInformationForDataArrays AdditionalInformationObject [get, set]
 Gets and sets the additional information to be stored at the data array.
 
string[] CommentsOfDataEntries [get, set]
 Get and set the comment for each dimension in C^N.
 
int DimensionalityOfCoordinates [get]
 Dimensionality M of the space of independent variables R^M.
 
int DimensionalityOfData [get]
 Dimensionality N of the space of data values C^N.
 
GraphicsAddOnData GraphicsAddons [get, set]
 The graphics add-on data to be drawn.
 
bool IsComplex [get]
 Are the values defined in C^N (TRUE) or in the subset of real numbers R^N (FALSE)
 
MeasuredQuantity[] MeasuredQuantitiesOfDataEntries [get, set]
 Gets and sets the measured quantity for each dimension in C^N. Currently, it is not always used. Thus PhysicalPropertiesOfDataEntries must be set consistently.
 
bool NoSmoothingInterpolationMethod [get]
 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.
 
PhysicalMeaning PhysicalMeaning [get, set]
 Gets and sets the physical meaning of the data array object (default: None)
 
PhysicalProperty[] PhysicalPropertiesOfDataEntries [get, set]
 Get and set the physical properties of each data subset.
 
PrecisionMode Precision [get]
 Get the highest occurring precision of the data.
 
string SuffixForPhysicalMeaning [get]
 Property which gives the suffix which is used in FormPhysicalObjectBase.SetTypeOfPhysicalObject.
 

Detailed Description

This class is subject to change. Programs using this class may require changes with a new version of VirtualLab.
Abstract class for storing a map R^M → C^N

Constructor & Destructor Documentation

◆ DataArrayBase()

copy constructor

Parameters
copyDAData array which shall be copied.

Property Documentation

◆ AdditionalInformationObject

AdditionalInformationForDataArrays AdditionalInformationObject
getset

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


◆ MeasuredQuantitiesOfDataEntries

MeasuredQuantity [] MeasuredQuantitiesOfDataEntries
getset

Gets and sets the measured quantity for each dimension in C^N. Currently, it is not always used. Thus PhysicalPropertiesOfDataEntries must be set consistently.