[This is preliminary documentation and is subject to change.]
DllData - This class represents a data object used by the user Dll. Before DLL's
computation stage, Visual Signal's ExternalDll will pass input descriptors
and data via setInputDescriptors(String), setInputDataRe(Int32, Int32, array<Double>[]()[]), and
setInputDataIm(Int32, Int32, array<Double>[]()[]) and converted automatically to an array of DllData objects.
User DLL may access these info directly via the member _inputData,
or via functions such as GetInputDataRe(Int32, Int32), GetInputDataIm(Int32, Int32), etc.
Declaration Syntax| C# | Visual Basic | Visual C++ |
protected class DllData
Protected Class DllData
protected ref class DllData
Members| All Members | Constructors | Methods | Properties | ||
| Icon | Member | Description |
|---|---|---|
 | TExternalBase..::.DllData()()() |
Empty constructor for the DllData class.
|
| TExternalBase..::.DllData(String, String, Int32, Boolean) |
Constructor for the DllData class. This constructor assumes a data ranke of 1.
|
| TExternalBase..::.DllData(String, String, Int32, Boolean, Int32) |
Constructor for the DllData class. This constructor will set the data rank,
and allocate coordinates and related arrays acoordingly.
|
 | ChannelCount |
Get/Set the channel count. Setting the property will automatically allocate
DataArray, ImagArray, and ChannelNames arrays.
|
| ChannelNames |
Get/Set channel names.
|
| Coordinates |
Get/Set the coordinate values in the form of a object[][] array for "Indexed"
coordinate Formats. This property is not used for "Regular" format.
The outer level represents multiple dimensions.
|
| DataArray |
Get/Set the real part of the data values in the form of a double[][] array.
The outer level represents multiple channels.
|
| Equals(Object) | (Inherited from Object.) |
 | Finalize()()() | Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.) |
| Formats |
Get/Set the format of each dimension's coordinate. Currently supported
formats are "Regular" and "Indexed". The "Regular" coordinate format requires
only Starts and Intervals properties to define
the regularly-spaced coordinates; the "Indexed" format requires the Coordinates
property to define the array of coordinates.
|
| GetHashCode()()() | Serves as a hash function for a particular type. GetHashCode()()() is suitable for use in hashing algorithms and data structures like a hash table. (Inherited from Object.) |
| GetType()()() | Gets the Type of the current instance. (Inherited from Object.) |
| ImagArray |
Get/Set the imaginary part of the data values in the form of a double[][] array.
The outer level represents multiple channels.
|
| Intervals |
Get/Set the interval value of each dimension's coordinate if the coordinate
Formats is "Regular". This property is not used if the format is "Indexed".
|
| IsComplex |
Get/Set whether data is complex (True/False).
|
| IsDateTimes |
Get/Set whether each dimension's coordinate is encoded DateTime value (True/False).
|
| Lengths |
Get/Set data lengths. For multi-dimensional data, the int[] array represents
the length for each dimension. For a vector data, length of int[] array is 1.
|
| MemberwiseClone()()() | Creates a shallow copy of the current Object. (Inherited from Object.) |
| Name |
Get/Set the data name
|
| Rank |
Get/Set the data rank. Setting this property will automatically allocate
Formats, Intervals, IsDateTimes, Lengths, Starts, Units, and Coordinates arrays.
|
| Starts |
Get/Set the starting value of each dimension's coordinate if the coordinate
Formats is "Regular". This property is not used if the format is "Indexed".
The actual values can be double-precision values, or a System.DateTime objects depending
on the IsDateTimes[] status. User must cast to the appropriate type when
reading this property.
|
| ToString()()() | (Inherited from Object.) |
| Type |
Get/Set the data type. Type could be one of the following strings:
"Signal", "Spectra", and "Numeric"
|
| Units |
Get/Set the unit string of each dimension's coordinate.
|
Inheritance Hierarchy| Object | |
 | TExternalBase..::.DllData |