logger::Annotations Struct Reference

#include <LoggerTypes.hpp>

Public Attributes
base::Time	time
std::string	stream_name
std::string	key
std::string	value

Detailed Description

Structure used to store metadata information / events in log files. It is used by creating a new log port, usually called "annotations", with the metadata rock_stream_type=annotations and this type

When metadata is associated with a particular stream, this scheme assumes that stream names are unique in a single file after discussion, we decided that it is a sane constraint, as most of the tooling would be made a lot more complex otherwise. Moreover, the stream index is not stable if you extract data out of a file.

Member Data Documentation

key

std::string logger::Annotations::key

The application-specific key. See http://rock.opendfki.de/wiki/WikiStart/OngoingWork/LogMetadata for some standard annotations

stream_name

std::string logger::Annotations::stream_name

If the annotation applies to a particular stream, the name of the stream. Can be left empty for general information

time

base::Time logger::Annotations::time

The time of this annotation. Assign to a null type (base::Time()) if no specific time is associated

value

std::string logger::Annotations::value

The application-specific value. See http://rock.opendfki.de/wiki/WikiStart/OngoingWork/LogMetadata for some standard annotations

---

The documentation for this struct was generated from the following file:

• /build/rock-master-18.09-tools-logger-0.20160617/LoggerTypes.hpp