Implementations common functions

The monitors and recorders share some methods:

  • isConnected → Inform on the connection status with the Heex Kernel
  • getUuid → return the ID of the monitor or recorder
  • getTimestampStr → Get the current time of the system in the iso_extended std::string format.

Recorder utility functions

These methods need to be called on labels argument.

void RecorderLabels::addLabel(const std::string& key, const std::string& value)

↳ Assigns the value to the key. Values are defaulted to an empty string.

void RecorderLabels::addLabel(const HeexGps& heexGps)

↳ Assigns the x and y position of a HeexGps structure to the position label.

std::pair<int, int> getSignalRecordingRange(const std::string triggerId = "", const std::string signalName = "") const;

↳ Returns a pair of min and max recording ranges for a signal. Possible to filter by triggerId, and by signal name.

std::unordered_set<RecordingSignal> getRecorderSignals(const std::string& triggerId = "") const;

↳ Returns the unordered_set of RecordingSignals of current recorder. Can filter by triggerId.

Recorder Query structure

Query for Labels

The query provided in the generateRequestedLabels() method is specified by the EventRecordingLabelsQuery structure.

You may extract the following fields from the query element to extract your Labels:

  • query.eventId → Event ID
  • query.triggerId → Trigger ID
  • query.timestamp → requested timestamp following the iso extended format

For more details, it is defined in the code as:

struct EventRecordingLabelsQuery
{
  std::string eventId;
  std::string triggerId;
  std::string timestamp;
}; // EventRecordingLabelsQuery

Query for Event Recording Parts

The query provided in the generateRequestedFilePaths() method is specified by the RecorderEventRecordingPartArgs structure. You may extract the following fields from the query element to generate your Event Recording Parts:

  • query.eventId → Event ID
  • query.triggerId → Trigger ID
  • query.timestamp → requested timestamp following the iso extended format
  • query.timestampedEventUuid → the event ID and timestamp concatenated

For more details, it is defined in the code as:

struct EventRecordingPartQuery
{
  std::string eventId;
  std::string triggerId;
  std::string timestamp;
  std::string timestampedEventUuid;
}; // EventRecordingPartQuery