Bio Radio SDK - Xamarin Android
|
Represents a single stream of samples from a device sensor. More...
Public Member Functions | |
void | Reset () |
Clears any data in the input buffer for this signal. More... | |
void | AddSample (uint timeStamp, long rawValue) |
Add Sample More... | |
long | GetNextRawValue () |
Returns the next raw sensor value in the buffer. More... | |
double [] | GetScaledValueArray () |
Used to retrieve an array of scaled sample values from the signal More... | |
double [] | GetScaledValueArray (int count) |
Creates an array of values representing the samples from the signal. More... | |
IEnumerable< double > | GetScaledValues () |
Enumerates over all scaled values currently in the signal buffer. More... | |
long [] | GetRawValueArray (int count) |
Gets an array of raw (unscaled) values from the signal. More... | |
IEnumerable< long > | GetRawValues (int count) |
Enumerates over raw values in the signal buffer. More... | |
IEnumerable< long > | GetRawValues () |
Enumerates over raw values in the signal buffer. More... | |
Sample | GetNextSample () |
Used to retrieve the next Sample object in the signal buffer. More... | |
IEnumerable< Sample > | GetSamples () |
Iterates over all samples currently in the signal buffer. More... | |
void | Dispose () |
Protected Member Functions | |
Signal () | |
Properties | |
SignalGroup | Owner [get] |
The SignalGroup to which this signal belongs. More... | |
int | SamplesPerSecond [get, set] |
The number of samples transmitted by the device in one second. More... | |
TimeSpan | SampleInterval [get, set] |
The time interval between sample readings. More... | |
double | MaxValue [get, set] |
The maximum scaled value that this signal supports. More... | |
double | MinValue [get, set] |
The miniumum scaled value that this signal supports. More... | |
double | RawMinValue [get, set] |
The minimum unscaled value that this signal supports. More... | |
double | RawMaxValue [get, set] |
The maximum unscaled value that this signal supports. More... | |
string | Name [get, set] |
The name associated with this signal. More... | |
string | Units [get, set] |
The units of measurement in which scaled values are reported. More... | |
int | ReadingsAvailable [get, set] |
The number of samples available to be read More... | |
bool | Enabled [get, set] |
Indicates whether the signal is enabled. More... | |
Represents a single stream of samples from a device sensor.
The sample class contains methods to read data from a device in various ways. It also contains metadata that describes the range of the signal values, the sample rate, and other pertinent details.
|
protected |
void GLNeuroTech.Devices.Common.Signal.AddSample | ( | uint | timeStamp, |
long | rawValue | ||
) |
Add Sample
timeStamp | |
rawValue |
void GLNeuroTech.Devices.Common.Signal.Dispose | ( | ) |
long GLNeuroTech.Devices.Common.Signal.GetNextRawValue | ( | ) |
Returns the next raw sensor value in the buffer.
Sample GLNeuroTech.Devices.Common.Signal.GetNextSample | ( | ) |
long [] GLNeuroTech.Devices.Common.Signal.GetRawValueArray | ( | int | count | ) |
Gets an array of raw (unscaled) values from the signal.
count | The number of samples to read |
IEnumerable<long> GLNeuroTech.Devices.Common.Signal.GetRawValues | ( | int | count | ) |
Enumerates over raw values in the signal buffer.
count | The number of values to read. Must be less than the total ReadingsAvailable |
ArgumentOutOfRangeException |
IEnumerable<long> GLNeuroTech.Devices.Common.Signal.GetRawValues | ( | ) |
Enumerates over raw values in the signal buffer.
IEnumerable<Sample> GLNeuroTech.Devices.Common.Signal.GetSamples | ( | ) |
Iterates over all samples currently in the signal buffer.
double [] GLNeuroTech.Devices.Common.Signal.GetScaledValueArray | ( | ) |
Used to retrieve an array of scaled sample values from the signal
double [] GLNeuroTech.Devices.Common.Signal.GetScaledValueArray | ( | int | count | ) |
Creates an array of values representing the samples from the signal.
count | The number of readings to read from the device. Must be less than or equal to the number of ReadingsAvailable |
IEnumerable<double> GLNeuroTech.Devices.Common.Signal.GetScaledValues | ( | ) |
Enumerates over all scaled values currently in the signal buffer.
void GLNeuroTech.Devices.Common.Signal.Reset | ( | ) |
Clears any data in the input buffer for this signal.
|
getset |
Indicates whether the signal is enabled.
Enabled is set to true by default. When set to false, no data will be saved to the signal. This is useful when there are unused signals being sent from the device. Disabling them will save system resources and processing time.
|
getset |
The maximum scaled value that this signal supports.
|
getset |
The miniumum scaled value that this signal supports.
|
getset |
The name associated with this signal.
|
get |
The SignalGroup to which this signal belongs.
All Signals belong to a SignalGroup which clusters similar signals together for convenient access.
|
getset |
The maximum unscaled value that this signal supports.
|
getset |
The minimum unscaled value that this signal supports.
|
getset |
The number of samples available to be read
|
getset |
The time interval between sample readings.
|
getset |
The number of samples transmitted by the device in one second.
|
getset |
The units of measurement in which scaled values are reported.