Represents a MicroStrain sample rate (rate at which data is sampling)
SampleRate( |
| ) |
Gets the string representation of the sample rate. Ex. 1Hz = "1-hertz", 10kHz = "10000-hertz", 1 per 10 seconds = "10-seconds", 1 per 1 minute = "60 seconds"
The sample rate represented as a string
Gets the string representation of the sample rate in a more human-readable format. Ex. 1Hz = "1Hz", 10kHz = "10kHz", 1 per 10 seconds = "Every 10 sec", 1 per 1 minute = "Every 1 min"
The sample rate represented as a string
Gets the sample period (time between samples) as a TimeSpan for the current sample rate
The TimeSpan representing the sample period
Error_UnknownSampleRate: The sample rate is unknown (such as with rateType_event)
Gets the number of samples per second.
The number of samples per second as a double
Error_UnknownSampleRate: The sample rate is unknown (such as with rateType_event)
Gets the sample rate type
The type of the current sample rate
Gets the number of samples for the sample rate (or seconds if less than 1 Hz)
The number of samples for the sample rate
Gets the WirelessTypes::WirelessSampleRate enum for the current SampleRate.
The WirelessTypes::WirelessSampleRate that is associated with the current SampleRate.
Error_UnknownSampleRate: The current SampleRate does not match a WirelessTypes::WirelessSampleRate.
static SampleRate Hertz( |
| ) |
Creates a SampleRate object from the given samples per second
samplesPerSecond uint32 | The number of samples per second (Hz) |
A SampleRate object built from the given parameter
static SampleRate KiloHertz( |
| ) |
Creates a SampleRate object from the given 1000 samples per second
kSamplesPerSecond uint32 | The number of 1000's samples per second (kHz) (20 kHz = 20) |
A SampleRate object built from the given parameter
static SampleRate Seconds( |
| ) |
Creates a SampleRate object from the given seconds between samples
secondsBetweenSamples uint32 | The number of seconds between samples (1 sample every 2 minutes = 120) |
A SampleRate object built from the given parameter
Creates a SampleRate object with the asynchronous/event type.
A SampleRate object of the event type.
static SampleRate FromWirelessEepromValue( |
| ) |
Creates a SampleRate object from the WirelessTypes::WirelessSampleRate value (the value that gets stored in eeprom).
eepromValue | The WirelessTypes::WirelessSampleRate value (the value that gets stored in eeprom). |
A SampleRate object built from the given parameter.
Error_UnknownSampleRate: The given WirelessTypes::WirelessSampleRate is invalid or unknown.
Represents the number of samples. If the sample rate type is Hertz, m_samples represents the number of samples per second (256 = 256 Hz). If the sample rate type is Seconds, m_samples represents the number of seconds (60 = 1 per 60 seconds, 120 = 1 per 2 minutes).
A typedef for a vector of SampleRate objects.