API version 1.5.2
SystemObject
VSignal.ExternalBaseTExternalBaseDllData
Assembly: vsmExternalBase (in vsmExternalBase.dll) Version: 1.6.0.0
Top
Top
Top
[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, Double), and
setInputDataIm(Int32, Int32, 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.
Inheritance Hierarchy
VSignal.ExternalBaseTExternalBaseDllData
Namespace: VSignal.ExternalBase
Assembly: vsmExternalBase (in vsmExternalBase.dll) Version: 1.6.0.0
Syntax
The TExternalBaseDllData type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
 | TExternalBaseDllData |
Empty constructor for the DllData class.
|
| TExternalBaseDllData(String, String, Int32, Boolean, Int32) |
Constructor for the DllData class. This constructor will set the data rank,
and allocate coordinates and related arrays accordingly.
|
Methods
| Name | Description | |
|---|---|---|
| AddEvent |
Add an event to the extension to the data extensions.
|
| DeserializeExtensions |
Deserialize extension data from XML
|
| Equals | (Inherited from Object.) |
 | Finalize | (Inherited from Object.) |
| GetEventFields |
Get all event fields from the data extension.
|
| GetEvents |
Get all events from the data extensions.
|
| GetExtension |
Obtain the extension info value of a specific key.
|
| GetExtensionKeys |
Obtain all the extension info keys available.
|
| GetHashCode | (Inherited from Object.) |
| GetType | (Inherited from Object.) |
| MemberwiseClone | (Inherited from Object.) |
| SerializeExtensions |
Serialize extension data to XML
|
| SetEventFields |
Set up event fields in the data extensions.
|
| SetExtension |
Setting a data extension info. Extension info will be used by specific
VisualSignal components and data, such as "BitsPerSample" for audio data, or
"XAxisTitle" for channel viewer.
|
| ToString | (Inherited from Object.) |
Properties
| Name | Description | |
|---|---|---|
 | 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.
|
| 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.
|
| 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.
|
| 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.
|
| 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.
|
See Also