Used to download logged data from a WirelessNode.
explicit DatalogDownloader( |
| ) |
Creates a DatalogDownloader object. Datalogging information will immediately be read from the Node.
node const WirelessNode& | The WirelessNode to download the data from. |
Error_NodeCommunication: Failed to read info from the Node.
Error_Connection: A connection error has occurred with the parent BaseStation.
Whether or not the first trigger has been found.
Whether or not we requested data that is out of bounds of the memory.
The current byte position into the Node's memory.
The 0-based count indicating which sweep we are currently on in the data.
The last log page that contains datalogging data.
The byte offset into the last log page containing datalogging data.
The NodeMemory object to help with interacting with the Node's datalogging memory.
The <DatalogSessionInfo> containing information about the current trigger session data.
uint8 read_uint8( |
| ) |
Reads a 1-byte unsigned integer from the Node's memory.
position uint64& | The 0-based position to read from. This value will be incremented by 1 if successful. |
The 1-byte uint8 at the requested position in the Node's memory.
Error_NodeCommunication: Failed to download data from the Node.
Error_NoData: The requested bytePosition is outside the range of the datalogged data.
Error_Connection: A connection error has occurred.
uint16 read_uint16( |
| ) |
Reads a 2-byte unsigned integer from the Node's memory.
position uint64& | The 0-based position to read from. This value will be incremented by 2 if successful. |
The uint16 at the requested position in the Node's memory.
Error_NodeCommunication: Failed to download data from the Node.
Error_NoData: The requested bytePosition is outside the range of the datalogged data.
Error_Connection: A connection error has occurred.
uint32 read_uint32( |
| ) |
Reads a 4-byte unsigned integer from the Node's memory.
position uint64& | The 0-based position to read from. This value will be incremented by 4 if successful. |
The uint32 at the requested position in the Node's memory.
Error_NodeCommunication: Failed to download data from the Node.
Error_NoData: The requested bytePosition is outside the range of the datalogged data.
Error_Connection: A connection error has occurred.
float read_float( |
| ) |
Reads a 4-byte float from the Node's memory.
position uint64& | The 0-based position to read from. This value will be incremented by 4 if successful. |
The float at the requested position in the Node's memory.
Error_NodeCommunication: Failed to download data from the Node.
Error_NoData: The requested bytePosition is outside the range of the datalogged data.
Error_Connection: A connection error has occurred.
std::string read_string( |
| ) |
Reads a string of the specified length from the Node's memory.
position uint64& | The 0-based position to start reading from. This value will be incremented by the length read if successful. |
length uint64 | The size (number of characters) to read for. |
The string at the requested position in the Node's memory, of the requested length.
Error_NodeCommunication: Failed to download data from the Node.
Error_NoData: The requested bytePosition is outside the range of the datalogged data.
Error_Connection: A connection error has occurred.
bool isStartOfTrigger( |
| ) |
Checks whether the given position is a start of a new trigger session.
position uint64 | The 0-based position to read from to check for a start of trigger. |
true if a start of trigger was found, false otherwise.
Error_NodeCommunication: Failed to download data from the Node.
Error_Connection: A connection error has occurred.
Parses a trigger header from the current byte position. The current datalogging session info in this class is updated.
Error_NodeCommunication: Failed to download data from the Node.
Error_Connection: A connection error has occurred.
Checks if all of the data has been downloaded (no more data available).
true if all the data has been downloaded, false if there is still more data to download.
Gets the next LoggedDataSweep that is logged to the Node.
A LoggedDataSweep containing the next data sweep that was logged to the Node.
Error_NodeCommunication: Failed to download data from the Node.
Error_NoData: The requested bytePosition is outside the range of the datalogged data.
Error_Connection: A connection error has occurred.
Gets whether a new datalogging session has been found (after calling getNextData). This will be true for a single LoggedDataSweep, signifying that all of the DatalogDownloader's info has been updated with new information (sample rate, session index, etc.) about this sweep.
true if a new datalogging session has been found, false otherwise.
Gets the WirelessTypes::TriggerType of the current datalogging session.
The WirelessTypes::TriggerType of the current datalogging session.
Gets the total number of sweeps that are in the current datalogging session.
The total number of sweeps that are in the current datalogging session.
Gets the index of the current datalogging session. This starts at 1 for the first session, and is incremented for each additional session.
The index of the current datalogging session.
Gets the SampleRate of the current datalogging session.
The SampleRate of the current datalogging session.
Gets the user entered string of the current datalogging session (if any).
The user entered string of the current datalogging session, or an empty string if none was provided.