NASA Astrobee Robot Software  0.19.1
Flight software for the Astrobee robots operating inside the International Space Station.
Public Member Functions | List of all members
localization_common::Averager Class Reference

#include <averager.h>

Public Member Functions

 Averager (const std::string &averager_name="", const std::string &type_name="", const std::string &units="", const bool log_on_destruction=false)
 
 ~Averager ()
 
void Update (const double value)
 
double average () const
 
int count () const
 
double last_value () const
 
void Log () const
 
void LogToFile (std::ofstream &ofstream) const
 
void LogToCsv (std::ofstream &ofstream) const
 
void LogEveryN (const int num_events_per_log) const
 
void UpdateAndLog (const double value)
 
void UpdateAndLogEveryN (const double value, const int num_events_per_log)
 
void Vlog (const int level=2) const
 
void VlogEveryN (const int num_events_per_log, const int level) const
 

Constructor & Destructor Documentation

◆ Averager()

localization_common::Averager::Averager ( const std::string &  averager_name = "",
const std::string &  type_name = "",
const std::string &  units = "",
const bool  log_on_destruction = false 
)
explicit

◆ ~Averager()

localization_common::Averager::~Averager ( )

Member Function Documentation

◆ average()

double localization_common::Averager::average ( ) const

◆ count()

int localization_common::Averager::count ( ) const

◆ last_value()

double localization_common::Averager::last_value ( ) const

◆ Log()

void localization_common::Averager::Log ( ) const

◆ LogEveryN()

void localization_common::Averager::LogEveryN ( const int  num_events_per_log) const

◆ LogToCsv()

void localization_common::Averager::LogToCsv ( std::ofstream &  ofstream) const

◆ LogToFile()

void localization_common::Averager::LogToFile ( std::ofstream &  ofstream) const

◆ Update()

void localization_common::Averager::Update ( const double  value)

◆ UpdateAndLog()

void localization_common::Averager::UpdateAndLog ( const double  value)

◆ UpdateAndLogEveryN()

void localization_common::Averager::UpdateAndLogEveryN ( const double  value,
const int  num_events_per_log 
)

◆ Vlog()

void localization_common::Averager::Vlog ( const int  level = 2) const

◆ VlogEveryN()

void localization_common::Averager::VlogEveryN ( const int  num_events_per_log,
const int  level 
) const
The documentation for this class was generated from the following files: