LoMetrics.C File Reference

This file defines the static data members and non-inline member functions of the lobot::Metrics class. More...

#include "Robots/LoBot/control/LoMetrics.H"
#include "Robots/LoBot/LoApp.H"
#include "Robots/LoBot/slam/LoMap.H"
#include "Robots/LoBot/config/LoConfigHelpers.H"
#include "Robots/LoBot/misc/LoRegistry.H"
#include "Robots/LoBot/misc/singleton.hh"
#include "Robots/LoBot/util/LoTime.H"
#include <fstream>
#include <algorithm>
#include <iterator>

Include dependency graph for LoMetrics.C:

Go to the source code of this file.

Functions
static void	lobot::dump (const std::vector< std::string > &messages)
Metrics::Log &	lobot::operator<< (Metrics::Log &metlog, const Metrics::endl &)
Metrics::Log &	lobot::operator<< (Metrics::Log &metlog, const Metrics::newl &)

---

Detailed Description

This file defines the static data members and non-inline member functions of the lobot::Metrics class.

Definition in file LoMetrics.C.

---

Variable Documentation

int m_dump_threshold

The metrics behaviour buffers all the metrics related messages sent by other behaviours and, periodically, when the buffer is "full," dumps the buffer to the log file. This setting specifies the minimum number of messages that should be collected before the internal buffer will be written to disk and cleared.

Definition at line 95 of file LoMetrics.C.

std::string m_log_file

This setting specifies the prefix of the file name to which the metrics should be written. By default, it is "/tmp/lobot-metrics-".

The remainder of the metrics log file's name is generated using the current time in the format "yyyymmdd-HHMMSS". There is no file name extension.

Definition at line 88 of file LoMetrics.C.

int m_opening_width

Most log messages begin with a small descriptive phrase such as "tracking pose" and are then followed by some values (such as the pose alluded to in the afore-mentioned phrase). To make the log more readable, all the opening phrases are written left-justified in a field width specified by this setting.

Definition at line 102 of file LoMetrics.C.

int m_update_delay

The number of milliseconds between successive iterations of this behaviour.

WARNING: The ability to change a behaviour's update frequency is a very powerful feature whose misuse or abuse can wreak havoc! Be sure to use reasonable values for this setting.

Definition at line 110 of file LoMetrics.C.