Skip to content

Log

struct nmeasim::core::log::Log · Library API

A parsed log: its sentences in file order with their offsets, and the header metadata.

#include <nmeasim/core/log/log_file.hpp>

Declared in src/core/include/nmeasim/core/log/log_file.hpp (line 79)

A log returned by parse_log has at least one entry; a default-constructed one has none.

Summary

Public member functions

Name Description
duration() Returns the length of a replay of the log.

Public data members

Name Description
entries The valid sentences in file order; the first has offset zero and offsets never decrease.
header Metadata from # key: value comment lines anywhere in the file, keyed by key, plus format from kHeaderLine.
timing Where the entry offsets came from.
skipped_lines Number of lines that are neither blank nor comments and yield no valid sentence: no $ or !, an unterminated TAG block or one whose checksum does not match, or a sentence that fails nmea0183::parse_sentence (such as a checksum mismatch).

Public member functions

duration()

std::chrono::milliseconds duration() const noexcept

Returns the length of a replay of the log.

Returns std::chrono::milliseconds: The offset of the last entry, or zero when there is none.

Declared in src/core/include/nmeasim/core/log/log_file.hpp:96 · defined in src/core/src/log/log_file.cpp:187

Public data members

entries

std::vector<LogEntry> entries

The valid sentences in file order; the first has offset zero and offsets never decrease.

Declared in src/core/include/nmeasim/core/log/log_file.hpp:82

std::map<std::string, std::string> header

Metadata from # key: value comment lines anywhere in the file, keyed by key, plus format from kHeaderLine.

A later line with the same key replaces an earlier one.

Declared in src/core/include/nmeasim/core/log/log_file.hpp:85

timing

TimingSource timing{TimingSource::FixedInterval}

Where the entry offsets came from.

Declared in src/core/include/nmeasim/core/log/log_file.hpp:87

skipped_lines

std::size_t skipped_lines{0}

Number of lines that are neither blank nor comments and yield no valid sentence: no $ or !, an unterminated TAG block or one whose checksum does not match, or a sentence that fails nmea0183::parse_sentence (such as a checksum mismatch).

Declared in src/core/include/nmeasim/core/log/log_file.hpp:91