MyGlobalProfiler Struct Reference

Detailed Description

Definition at line 25 of file CTimeLogger.cpp.

Inheritance diagram for MyGlobalProfiler:

Public Member Functions
	MyGlobalProfiler ()
	~MyGlobalProfiler () override
	MyGlobalProfiler (const MyGlobalProfiler &)=delete
	MyGlobalProfiler (MyGlobalProfiler &&)=delete
MyGlobalProfiler &	operator= (const MyGlobalProfiler &)=delete
MyGlobalProfiler &	operator= (MyGlobalProfiler &&)=delete
std::string	getStatsAsText (const size_t column_width=80) const
	Dump all stats to a multi-line text string. More...
void	getStats (std::map< std::string, TCallStats > &out_stats) const
	Returns all the current stats as a map: section_name => stats. More...
void	dumpAllStats (const size_t column_width=80) const
	Dump all stats through the COutputLogger interface. More...
void	clear (bool deep_clear=false)
	Resets all stats. More...
void	enable (bool enabled=true)
void	disable ()
bool	isEnabled () const
void	enableKeepWholeHistory (bool enable=true)
bool	isEnabledKeepWholeHistory () const
void	saveToCSVFile (const std::string &csv_file) const
	Dump all stats to a Comma Separated Values (CSV) file. More...
void	saveToMFile (const std::string &m_file) const
	Dump all stats to a Matlab/Octave (.m) file. More...
void	registerUserMeasure (const std::string_view &event_name, const double value, const bool is_time=false) noexcept
const std::string &	getName () const noexcept
void	setName (const std::string &name) noexcept
void	enter (const std::string_view &func_name) noexcept
	Start of a named section. More...
double	leave (const std::string_view &func_name) noexcept
	End of a named section. More...
double	getMeanTime (const std::string &name) const
	Return the mean execution time of the given "section", or 0 if it hasn't ever been called "enter" with that section name. More...
double	getLastTime (const std::string &name) const
	Return the last execution time of the given "section", or 0 if it hasn't ever been called "enter" with that section name. More...

Static Public Member Functions
static std::array< mrpt::system::TConsoleColor, NUMBER_OF_VERBOSITY_LEVELS > &	logging_levels_to_colors ()
	Map from VerbosityLevels to their corresponding mrpt::system::TConsoleColor. More...
static std::array< std::string, NUMBER_OF_VERBOSITY_LEVELS > &	logging_levels_to_names ()
	Map from VerbosityLevels to their corresponding names. More...

Protected Types
using	TDataMap = mrpt::containers::ts_hash_map< std::string, TCallData, HASH_SIZE_IN_BYTES, HASH_ALLOWED_COLLISIONS >

Protected Member Functions
void	do_enter (const std::string_view &func_name) noexcept
double	do_leave (const std::string_view &func_name) noexcept

Protected Attributes
TDataMap	m_data
VerbosityLevel	m_min_verbosity_level {LVL_INFO}
	Provided messages with VerbosityLevel smaller than this value shall be ignored. More...

Static Protected Attributes
static constexpr unsigned int	HASH_SIZE_IN_BYTES = 1
static constexpr unsigned int	HASH_ALLOWED_COLLISIONS = 10

Logging methods
void	logStr (const VerbosityLevel level, std::string_view msg_str) const
	Main method to add the specified message string to the logger. More...
void	logFmt (const VerbosityLevel level, const char *fmt,...) const MRPT_printf_format_check(3
	Alternative logging method, which mimics the printf behavior. More...
void void	logCond (const VerbosityLevel level, bool cond, const std::string &msg_str) const
	Log the given message only if the condition is satisfied. More...
void	setLoggerName (const std::string &name)
	Set the name of the COutputLogger instance. More...
std::string	getLoggerName () const
	Return the name of the COutputLogger instance. More...
void	setMinLoggingLevel (const VerbosityLevel level)
	Set the minimum logging level for which the incoming logs are going to be taken into account. More...
void	setVerbosityLevel (const VerbosityLevel level)
	alias of setMinLoggingLevel() More...
VerbosityLevel	getMinLoggingLevel () const
bool	isLoggingLevelVisible (VerbosityLevel level) const
void	getLogAsString (std::string &log_contents) const
	Fill the provided string with the contents of the logger's history in std::string representation. More...
std::string	getLogAsString () const
	Get the history of COutputLogger instance in a string representation. More...
void	writeLogToFile (const std::string *fname_in=nullptr) const
	Write the contents of the COutputLogger instance to an external file. More...
void	dumpLogToConsole () const
	Dump the current contents of the COutputLogger instance in the terminal window. More...
std::string	getLoggerLastMsg () const
	Return the last Tmsg instance registered in the logger history. More...
void	getLoggerLastMsg (std::string &msg_str) const
	Fill inputtted string with the contents of the last message in history. More...
void	loggerReset ()
	Reset the contents of the logger instance. More...
void	logRegisterCallback (output_logger_callback_t userFunc)
bool	logDeregisterCallback (output_logger_callback_t userFunc)
bool	logging_enable_console_output {true}
	[Default=true] Set it to false in case you don't want the logged messages to be dumped to the output automatically. More...
bool	logging_enable_keep_record {false}
	[Default=false] Enables storing all messages into an internal list. More...

Member Typedef Documentation

TDataMap

using mrpt::system::CTimeLogger::TDataMap = mrpt::containers::ts_hash_map< std::string, TCallData, HASH_SIZE_IN_BYTES, HASH_ALLOWED_COLLISIONS>

protectedinherited

Definition at line 75 of file system/CTimeLogger.h.

Constructor & Destructor Documentation

MyGlobalProfiler() [1/3]

MyGlobalProfiler::MyGlobalProfiler ( )

inline

Definition at line 27 of file CTimeLogger.cpp.

~MyGlobalProfiler()

MyGlobalProfiler::~MyGlobalProfiler ( )

inlineoverride

Definition at line 28 of file CTimeLogger.cpp.

MyGlobalProfiler() [2/3]

MyGlobalProfiler::MyGlobalProfiler ( const MyGlobalProfiler &  )

delete

MyGlobalProfiler() [3/3]

MyGlobalProfiler::MyGlobalProfiler ( MyGlobalProfiler &&  )

delete

Member Function Documentation

clear()

void CTimeLogger::clear ( bool  deep_clear = false )

inherited

Resets all stats.

By default (deep_clear=false), all section names are remembered (not freed) so the cost of creating upon the first next call is avoided.

Definition at line 82 of file CTimeLogger.cpp.

References mrpt::containers::deep_clear(), and mrpt::system::CTimeLogger::m_data.

Here is the call graph for this function:

disable()

void mrpt::system::CTimeLogger::disable ( )

inlineinherited

Definition at line 118 of file system/CTimeLogger.h.

References mrpt::system::CTimeLogger::m_enabled.

do_enter()

void CTimeLogger::do_enter ( const std::string_view &  func_name )

protectednoexceptinherited

Definition at line 299 of file CTimeLogger.cpp.

References mrpt::system::CTimeLogger::m_data, mrpt::system::CTimeLogger::m_tictac, mrpt::system::CTimeLogger::TCallData::n_calls, and mrpt::system::CTicTac::Tac().

Referenced by mrpt::system::CTimeLogger::enter().

Here is the call graph for this function:

Here is the caller graph for this function:

do_leave()

double CTimeLogger::do_leave ( const std::string_view &  func_name )

protectednoexceptinherited

Definition at line 314 of file CTimeLogger.cpp.

References mrpt::keep_max(), mrpt::keep_min(), mrpt::system::CTimeLogger::m_data, mrpt::system::CTimeLogger::m_keep_whole_history, mrpt::system::CTimeLogger::m_tictac, mrpt::system::CTimeLogger::TCallData::open_calls, and mrpt::system::CTicTac::Tac().

Referenced by mrpt::system::CTimeLogger::leave().

Here is the call graph for this function:

Here is the caller graph for this function:

dumpAllStats()

void CTimeLogger::dumpAllStats ( const size_t  column_width = 80 ) const

inherited

Dump all stats through the COutputLogger interface.

See also

getStatsAsText, saveToCVSFile

Definition at line 294 of file CTimeLogger.cpp.

References mrpt::system::CTimeLogger::getStatsAsText(), and MRPT_LOG_INFO_STREAM.

Referenced by mrpt::system::CTimeLogger::~CTimeLogger().

Here is the call graph for this function:

Here is the caller graph for this function:

dumpLogToConsole()

void COutputLogger::dumpLogToConsole ( ) const

inherited

Dump the current contents of the COutputLogger instance in the terminal window.

See also

writeToFile

Definition at line 190 of file COutputLogger.cpp.

enable()

void mrpt::system::CTimeLogger::enable ( bool  enabled = true )

inlineinherited

Definition at line 117 of file system/CTimeLogger.h.

References mrpt::system::CTimeLogger::m_enabled.

Referenced by mrpt::system::CTimeLogger::enableKeepWholeHistory(), mrpt::nav::CAbstractPTGBasedReactive::enableTimeLog(), mrpt::vision::CGenericFeatureTracker::enableTimeLogger(), mrpt::nav::CAbstractNavigator::loadConfigFile(), and mrpt::graphs::ScalarFactorGraph::updateEstimation().

Here is the caller graph for this function:

enableKeepWholeHistory()

void mrpt::system::CTimeLogger::enableKeepWholeHistory ( bool  enable = true )

inlineinherited

Definition at line 121 of file system/CTimeLogger.h.

References mrpt::system::CTimeLogger::enable(), and mrpt::system::CTimeLogger::m_keep_whole_history.

Here is the call graph for this function:

enter()

void mrpt::system::CTimeLogger::enter ( const std::string_view &  func_name )

inlinenoexceptinherited

Start of a named section.

See also

enter

Definition at line 140 of file system/CTimeLogger.h.

References mrpt::system::CTimeLogger::do_enter(), and mrpt::system::CTimeLogger::m_enabled.

Referenced by mrpt::bayes::detail::addNewLandmarks(), mrpt::system::global_profiler_enter(), mrpt::nav::CReactiveNavigationSystem3D::implementSenseObstacles(), mrpt::opengl::CRenderizableShaderTexturedTriangles::initializeTextures(), main(), mrpt::graphslam::optimize_graph_spa_levmarq(), mrpt::nav::CAbstractPTGBasedReactive::STEP8_GenerateLogRecord(), mrpt::graphs::ScalarFactorGraph::updateEstimation(), and mrpt::graphslam::deciders::CICPCriteriaNRD< GRAPH_T >::updateState().

Here is the call graph for this function:

Here is the caller graph for this function:

getLastTime()

double CTimeLogger::getLastTime ( const std::string &  name ) const

inherited

Return the last execution time of the given "section", or 0 if it hasn't ever been called "enter" with that section name.

Definition at line 405 of file CTimeLogger.cpp.

References mrpt::system::CTimeLogger::m_data.

Referenced by mrpt::nav::CAbstractPTGBasedReactive::performNavigationStep(), and mrpt::nav::CAbstractPTGBasedReactive::STEP8_GenerateLogRecord().

Here is the caller graph for this function:

getLogAsString() [1/2]

void COutputLogger::getLogAsString ( std::string &  log_contents ) const

inherited

Fill the provided string with the contents of the logger's history in std::string representation.

Definition at line 154 of file COutputLogger.cpp.

getLogAsString() [2/2]

std::string COutputLogger::getLogAsString ( ) const

inherited

Get the history of COutputLogger instance in a string representation.

Definition at line 159 of file COutputLogger.cpp.

Referenced by mrpt::graphslam::deciders::CICPCriteriaNRD< GRAPH_T >::getDescriptiveReport().

Here is the caller graph for this function:

getLoggerLastMsg() [1/2]

std::string COutputLogger::getLoggerLastMsg ( ) const

inherited

Return the last Tmsg instance registered in the logger history.

Definition at line 195 of file COutputLogger.cpp.

References mrpt::system::COutputLogger::TMsg::getAsString().

Here is the call graph for this function:

getLoggerLastMsg() [2/2]

void COutputLogger::getLoggerLastMsg ( std::string &  msg_str ) const

inherited

Fill inputtted string with the contents of the last message in history.

Definition at line 201 of file COutputLogger.cpp.

getLoggerName()

std::string COutputLogger::getLoggerName ( ) const

inherited

Return the name of the COutputLogger instance.

See also

setLoggerName

Definition at line 143 of file COutputLogger.cpp.

getMeanTime()

double CTimeLogger::getMeanTime ( const std::string &  name ) const

inherited

Return the mean execution time of the given "section", or 0 if it hasn't ever been called "enter" with that section name.

Definition at line 397 of file CTimeLogger.cpp.

References mrpt::system::CTimeLogger::m_data.

getMinLoggingLevel()

VerbosityLevel mrpt::system::COutputLogger::getMinLoggingLevel ( ) const

inlineinherited

See also

setMinLoggingLevel

Definition at line 201 of file system/COutputLogger.h.

References mrpt::system::COutputLogger::m_min_verbosity_level.

Referenced by mrpt::apps::RawlogGrabberApp::dump_verbose_info(), mrpt::maps::CRandomFieldGridMap2D::isEnabledVerbose(), mrpt::slam::CMetricMapBuilderRBPF::processActionObservation(), mrpt::apps::CGridMapAlignerApp::run(), mrpt::apps::RBPF_SLAM_App_Base::run(), and mrpt::apps::ICP_SLAM_App_Base::run().

Here is the caller graph for this function:

getName()

const std::string& mrpt::system::CTimeLogger::getName ( ) const

inlinenoexceptinherited

Definition at line 136 of file system/CTimeLogger.h.

References mrpt::system::CTimeLogger::m_name.

Referenced by mrpt::system::CTimeLoggerSaveAtDtor::~CTimeLoggerSaveAtDtor().

Here is the caller graph for this function:

getStats()

void CTimeLogger::getStats ( std::map< std::string, TCallStats > &  out_stats ) const

inherited

Returns all the current stats as a map: section_name => stats.

See also

getStatsAsText, dumpAllStats, saveToCVSFile

Definition at line 104 of file CTimeLogger.cpp.

References mrpt::system::CTimeLogger::TCallStats::last_t, mrpt::system::CTimeLogger::m_data, mrpt::system::CTimeLogger::TCallStats::max_t, mrpt::system::CTimeLogger::TCallStats::mean_t, mrpt::system::CTimeLogger::TCallStats::min_t, mrpt::system::CTimeLogger::TCallStats::n_calls, and mrpt::system::CTimeLogger::TCallStats::total_t.

getStatsAsText()

std::string CTimeLogger::getStatsAsText ( const size_t  column_width = 80 ) const

inherited

Dump all stats to a multi-line text string.

See also

dumpAllStats, saveToCVSFile

Definition at line 119 of file CTimeLogger.cpp.

References aux_format_string_multilines(), mrpt::format(), mrpt::system::CTimeLogger::m_data, mrpt::system::CTimeLogger::m_name, and mrpt::system::unitsFormat().

Referenced by mrpt::system::CTimeLogger::dumpAllStats(), and mrpt::graphslam::deciders::CICPCriteriaNRD< GRAPH_T >::getDescriptiveReport().

Here is the call graph for this function:

Here is the caller graph for this function:

isEnabled()

bool mrpt::system::CTimeLogger::isEnabled ( ) const

inlineinherited

Definition at line 119 of file system/CTimeLogger.h.

References mrpt::system::CTimeLogger::m_enabled.

Referenced by mrpt::nav::CAbstractPTGBasedReactive::build_movement_candidate(), and mrpt::nav::CAbstractNavigator::loadConfigFile().

Here is the caller graph for this function:

isEnabledKeepWholeHistory()

bool mrpt::system::CTimeLogger::isEnabledKeepWholeHistory ( ) const

inlineinherited

Definition at line 125 of file system/CTimeLogger.h.

References mrpt::system::CTimeLogger::m_keep_whole_history.

isLoggingLevelVisible()

bool mrpt::system::COutputLogger::isLoggingLevelVisible ( VerbosityLevel  level ) const

inlineinherited

Definition at line 202 of file system/COutputLogger.h.

References mrpt::system::COutputLogger::m_min_verbosity_level.

Referenced by mrpt::slam::CMetricMapBuilderRBPF::processActionObservation(), and mrpt::system::COutputLoggerStreamWrapper::~COutputLoggerStreamWrapper().

Here is the caller graph for this function:

leave()

double mrpt::system::CTimeLogger::leave ( const std::string_view &  func_name )

inlinenoexceptinherited

End of a named section.

Returns

The ellapsed time, in seconds or 0 if disabled.

See also

enter

Definition at line 146 of file system/CTimeLogger.h.

References mrpt::system::CTimeLogger::do_leave(), and mrpt::system::CTimeLogger::m_enabled.

Referenced by mrpt::bayes::detail::addNewLandmarks(), mrpt::system::global_profiler_leave(), mrpt::nav::CReactiveNavigationSystem3D::implementSenseObstacles(), mrpt::opengl::CRenderizableShaderTexturedTriangles::initializeTextures(), mrpt::graphslam::optimize_graph_spa_levmarq(), mrpt::nav::CAbstractPTGBasedReactive::STEP8_GenerateLogRecord(), mrpt::graphs::ScalarFactorGraph::updateEstimation(), and mrpt::graphslam::deciders::CICPCriteriaNRD< GRAPH_T >::updateState().

Here is the call graph for this function:

Here is the caller graph for this function:

logCond()

void COutputLogger::logCond ( const VerbosityLevel  level, bool  cond, const std::string &  msg_str  ) const

inherited

Log the given message only if the condition is satisfied.

See also

log, logFmt

Definition at line 131 of file COutputLogger.cpp.

logDeregisterCallback()

bool COutputLogger::logDeregisterCallback ( output_logger_callback_t  userFunc )

inherited

Returns

true if an entry was found and deleted.

Definition at line 291 of file COutputLogger.cpp.

References getAddress(), and mrpt::system::COutputLogger::m_listCallbacks.

Here is the call graph for this function:

logFmt()

void COutputLogger::logFmt ( const VerbosityLevel  level, const char *  fmt,   ...  ) const

inherited

Alternative logging method, which mimics the printf behavior.

Handy for not having to first use mrpt::format to pass a std::string message to logStr

// instead of:
logStr(mrpt::format("Today is the %d of %s, %d", 15, "July", 2016));

// one can use:
logFmt("Today is the %d of %s, %d", 15, "July", 2016);

See also

logStr, logCond

Definition at line 91 of file COutputLogger.cpp.

Referenced by mrpt::hmtslam::CHMTSLAM::areaAbstraction(), mrpt::graphslam::deciders::CICPCriteriaNRD< GRAPH_T >::CICPCriteriaNRD(), mrpt::hmtslam::CTopLCDetector_GridMatching::computeTopologicalObservationModel(), CGraphSlamHandler< GRAPH_T >::execute(), mrpt::math::CLevenbergMarquardtTempl< VECTORTYPE, USERPARAM >::execute(), CGraphSlamHandler< GRAPH_T >::initOutputDir(), CGraphSlamHandler< GRAPH_T >::initVisualization(), mrpt::nav::CNavigatorManualSequence::navigationStep(), mrpt::nav::CAbstractNavigator::performNavigationStepNavigating(), CGraphSlamHandler< GRAPH_T >::readConfigFname(), CGraphSlamHandler< GRAPH_T >::saveResults(), CGraphSlamHandler< GRAPH_T >::setResultsDirName(), mrpt::nav::CReactiveNavigationSystem::STEP1_InitPTGs(), mrpt::hmtslam::CHMTSLAM::thread_3D_viewer(), mrpt::hmtslam::CHMTSLAM::thread_LSLAM(), mrpt::hmtslam::CHMTSLAM::thread_TBI(), and CGraphSlamHandler< GRAPH_T >::~CGraphSlamHandler().

Here is the caller graph for this function:

loggerReset()

void COutputLogger::loggerReset ( )

inherited

Reset the contents of the logger instance.

Called upon construction.

Definition at line 206 of file COutputLogger.cpp.

References mrpt::system::LVL_INFO.

logging_levels_to_colors()

std::array< mrpt::system::TConsoleColor, NUMBER_OF_VERBOSITY_LEVELS > & COutputLogger::logging_levels_to_colors ( )

staticinherited

Map from VerbosityLevels to their corresponding mrpt::system::TConsoleColor.

Handy for coloring the input based on the verbosity of the message

Definition at line 47 of file COutputLogger.cpp.

References logging_levels_to_colors.

Referenced by mrpt::system::COutputLogger::TMsg::dumpToConsole().

Here is the caller graph for this function:

logging_levels_to_names()

std::array< std::string, NUMBER_OF_VERBOSITY_LEVELS > & COutputLogger::logging_levels_to_names ( )

staticinherited

Map from VerbosityLevels to their corresponding names.

Handy for printing the current message VerbosityLevel along with the actual content

Definition at line 60 of file COutputLogger.cpp.

References logging_levels_to_names.

Referenced by mrpt::system::COutputLogger::TMsg::getAsString().

Here is the caller graph for this function:

logRegisterCallback()

void COutputLogger::logRegisterCallback ( output_logger_callback_t  userFunc )

inherited

Definition at line 278 of file COutputLogger.cpp.

References mrpt::system::COutputLogger::m_listCallbacks.

logStr()

void COutputLogger::logStr ( const VerbosityLevel  level, std::string_view  msg_str  ) const

inherited

Main method to add the specified message string to the logger.

See also

logCond, logFmt

Definition at line 72 of file COutputLogger.cpp.

References mrpt::system::COutputLogger::TMsg::body, mrpt::system::COutputLogger::TMsg::dumpToConsole(), mrpt::system::COutputLogger::TMsg::level, mrpt::system::COutputLogger::TMsg::name, and mrpt::system::COutputLogger::TMsg::timestamp.

Referenced by mrpt::slam::PF_implementation< mrpt::math::TPose3D, CMonteCarloLocalization3D, mrpt::bayes::particle_storage_mode::VALUE >::PF_SLAM_implementation_pfAuxiliaryPFStandardAndOptimal(), mrpt::nav::CReactiveNavigationSystem::STEP1_InitPTGs(), mrpt::system::COutputLoggerStreamWrapper::~COutputLoggerStreamWrapper(), and mrpt::system::CTimeLoggerSaveAtDtor::~CTimeLoggerSaveAtDtor().

Here is the call graph for this function:

Here is the caller graph for this function:

operator=() [1/2]

MyGlobalProfiler& MyGlobalProfiler::operator= ( const MyGlobalProfiler &  )

delete

operator=() [2/2]

MyGlobalProfiler& MyGlobalProfiler::operator= ( MyGlobalProfiler &&  )

delete

registerUserMeasure()

void CTimeLogger::registerUserMeasure ( const std::string_view &  event_name, const double  value, const bool  is_time = false  )

noexceptinherited

Definition at line 358 of file CTimeLogger.cpp.

References mrpt::system::CTimeLogger::TCallData::has_time_units, mrpt::keep_max(), mrpt::keep_min(), mrpt::system::CTimeLogger::m_data, mrpt::system::CTimeLogger::m_enabled, and mrpt::system::CTimeLogger::m_keep_whole_history.

Referenced by mrpt::nav::CAbstractPTGBasedReactive::build_movement_candidate(), and mrpt::system::CTimeLoggerEntry::stop().

Here is the call graph for this function:

Here is the caller graph for this function:

saveToCSVFile()

void CTimeLogger::saveToCSVFile ( const std::string &  csv_file ) const

inherited

Dump all stats to a Comma Separated Values (CSV) file.

See also

dumpAllStats

Definition at line 210 of file CTimeLogger.cpp.

References mrpt::format(), mrpt::system::CTimeLogger::m_data, and mrpt::to_string().

Here is the call graph for this function:

saveToMFile()

void CTimeLogger::saveToMFile ( const std::string &  m_file ) const

inherited

Dump all stats to a Matlab/Octave (.m) file.

See also

dumpAllStats

Definition at line 238 of file CTimeLogger.cpp.

References mrpt::system::extractFileName(), mrpt::system::fileNameStripInvalidChars(), mrpt::format(), mrpt::system::CTimeLogger::m_data, and mrpt::to_string().

Referenced by mrpt::system::CTimeLoggerSaveAtDtor::~CTimeLoggerSaveAtDtor().

Here is the call graph for this function:

Here is the caller graph for this function:

setLoggerName()

void COutputLogger::setLoggerName ( const std::string &  name )

inherited

Set the name of the COutputLogger instance.

See also

getLoggerName

Definition at line 138 of file COutputLogger.cpp.

Referenced by mrpt::slam::CMetricMapBuilderICP::CMetricMapBuilderICP(), mrpt::slam::CMetricMapBuilderRBPF::CMetricMapBuilderRBPF(), mrpt::slam::CMonteCarloLocalization2D::CMonteCarloLocalization2D(), mrpt::slam::CMonteCarloLocalization3D::CMonteCarloLocalization3D(), mrpt::apps::ICP_SLAM_App_Base::ICP_SLAM_App_Base(), mrpt::apps::ICP_SLAM_App_Live::ICP_SLAM_App_Live(), mrpt::apps::ICP_SLAM_App_Rawlog::ICP_SLAM_App_Rawlog(), mrpt::graphslam::CWindowManager::initCWindowManager(), mrpt::apps::MonteCarloLocalization_Base::MonteCarloLocalization_Base(), mrpt::apps::RBPF_SLAM_App_Base::RBPF_SLAM_App_Base(), and mrpt::apps::RBPF_SLAM_App_Rawlog::RBPF_SLAM_App_Rawlog().

Here is the caller graph for this function:

setMinLoggingLevel()

void COutputLogger::setMinLoggingLevel ( const VerbosityLevel  level )

inherited

Set the minimum logging level for which the incoming logs are going to be taken into account.

String messages with specified VerbosityLevel smaller than the min, will not be outputted to the screen and neither will a record of them be stored in by the COutputLogger instance

Definition at line 144 of file COutputLogger.cpp.

Referenced by mrpt::maps::CRandomFieldGridMap2D::enableVerbose(), mrpt::math::CLevenbergMarquardtTempl< VECTORTYPE, USERPARAM >::execute(), generic_kf_slam_test(), generic_pf_test(), generic_rbpf_slam_test(), mrpt::apps::RawlogGrabberApp::initialize(), mrpt::hwdrivers::CHokuyoURG::initialize(), mrpt::graphslam::deciders::CICPCriteriaNRD< GRAPH_T >::loadParams(), mrpt::apps::CGridMapAlignerApp::run(), mrpt::apps::RBPF_SLAM_App_Base::run(), and mrpt::apps::ICP_SLAM_App_Base::run().

Here is the caller graph for this function:

setName()

void mrpt::system::CTimeLogger::setName ( const std::string &  name )

inlinenoexceptinherited

Definition at line 137 of file system/CTimeLogger.h.

References mrpt::system::CTimeLogger::m_name.

setVerbosityLevel()

void COutputLogger::setVerbosityLevel ( const VerbosityLevel  level )

inherited

alias of setMinLoggingLevel()

Definition at line 149 of file COutputLogger.cpp.

Referenced by mrpt::nav::CAbstractNavigator::CAbstractNavigator(), mrpt::slam::CMetricMapBuilderRBPF::CMetricMapBuilderRBPF(), mrpt::comms::CServerTCPSocket::CServerTCPSocket(), mrpt::slam::CMetricMapBuilderRBPF::processActionObservation(), mrpt::math::ransac_detect_2D_lines(), and mrpt::apps::ICP_SLAM_App_Base::run().

Here is the caller graph for this function:

writeLogToFile()

void COutputLogger::writeLogToFile ( const std::string *  fname_in = nullptr ) const

inherited

Write the contents of the COutputLogger instance to an external file.

Upon call to this method, COutputLogger dumps the contents of all the logged commands so far to the specified external file. By default the filename is set to ${LOGGERNAME}.log except if the fname parameter is provided

See also

dumpToConsole, getAsString

Definition at line 165 of file COutputLogger.cpp.

References ASSERTMSG_, and mrpt::format().

Here is the call graph for this function:

Member Data Documentation

HASH_ALLOWED_COLLISIONS

constexpr unsigned int mrpt::system::CTimeLogger::HASH_ALLOWED_COLLISIONS = 10

staticprotectedinherited

Definition at line 72 of file system/CTimeLogger.h.

HASH_SIZE_IN_BYTES

constexpr unsigned int mrpt::system::CTimeLogger::HASH_SIZE_IN_BYTES = 1

staticprotectedinherited

Definition at line 71 of file system/CTimeLogger.h.

logging_enable_console_output

bool mrpt::system::COutputLogger::logging_enable_console_output {true}

inherited

[Default=true] Set it to false in case you don't want the logged messages to be dumped to the output automatically.

Definition at line 240 of file system/COutputLogger.h.

logging_enable_keep_record

bool mrpt::system::COutputLogger::logging_enable_keep_record {false}

inherited

[Default=false] Enables storing all messages into an internal list.

See also

writeLogToFile, getLogAsString

Definition at line 243 of file system/COutputLogger.h.

m_data

TDataMap mrpt::system::CTimeLogger::m_data

protectedinherited

Definition at line 77 of file system/CTimeLogger.h.

Referenced by mrpt::system::CTimeLogger::clear(), mrpt::system::CTimeLogger::do_enter(), mrpt::system::CTimeLogger::do_leave(), mrpt::system::CTimeLogger::getLastTime(), mrpt::system::CTimeLogger::getMeanTime(), mrpt::system::CTimeLogger::getStats(), mrpt::system::CTimeLogger::getStatsAsText(), mrpt::system::CTimeLogger::registerUserMeasure(), mrpt::system::CTimeLogger::saveToCSVFile(), mrpt::system::CTimeLogger::saveToMFile(), and mrpt::system::CTimeLogger::~CTimeLogger().

m_min_verbosity_level

VerbosityLevel mrpt::system::COutputLogger::m_min_verbosity_level {LVL_INFO}

protectedinherited

Provided messages with VerbosityLevel smaller than this value shall be ignored.

Definition at line 253 of file system/COutputLogger.h.

Referenced by mrpt::system::COutputLogger::getMinLoggingLevel(), and mrpt::system::COutputLogger::isLoggingLevelVisible().