MRPT  2.0.4
List of all members | Public Member Functions | Static Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | Static Protected Attributes | Private Member Functions | Private Attributes
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
 
MyGlobalProfileroperator= (const MyGlobalProfiler &)=delete
 
MyGlobalProfileroperator= (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

constexpr static unsigned int HASH_SIZE_IN_BYTES = 1
 
constexpr static unsigned int HASH_ALLOWED_COLLISIONS = 10
 

Private Member Functions

std::string generateStringFromFormat (std::string_view fmt, va_list argp) const
 Helper method for generating a std::string instance from printf-like arguments. More...
 

Private Attributes

CTicTac m_tictac
 
bool m_enabled
 
std::string m_name
 
bool m_keep_whole_history {false}
 
std::string m_logger_name
 
std::deque< TMsgm_history
 
std::deque< output_logger_callback_t > m_listCallbacks
 

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

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.

◆ 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

◆ do_leave()

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

◆ 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().

◆ 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

◆ enableKeepWholeHistory()

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

◆ enter()

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

◆ generateStringFromFormat()

std::string COutputLogger::generateStringFromFormat ( std::string_view  fmt,
va_list  argp 
) const
privateinherited

Helper method for generating a std::string instance from printf-like arguments.

Definition at line 110 of file COutputLogger.cpp.

References mrpt::system::os::vsnprintf().

◆ 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().

◆ getLogAsString() [1/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().

◆ getLogAsString() [2/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.

◆ 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().

◆ 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

◆ getName()

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

◆ getStats()

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

◆ getStatsAsText()

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

◆ isEnabled()

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

◆ isEnabledKeepWholeHistory()

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

◆ isLoggingLevelVisible()

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

◆ leave()

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

◆ 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.

◆ logFmt()

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

◆ 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().

◆ 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().

◆ 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

◆ 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

◆ 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().

◆ saveToMFile()

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

◆ setLoggerName()

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

◆ 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().

◆ 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

◆ 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().

Member Data Documentation

◆ HASH_ALLOWED_COLLISIONS

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

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

◆ HASH_SIZE_IN_BYTES

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

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

◆ m_enabled

bool mrpt::system::CTimeLogger::m_enabled
privateinherited

◆ m_history

std::deque<TMsg> mrpt::system::COutputLogger::m_history
mutableprivateinherited

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

◆ m_keep_whole_history

bool mrpt::system::CTimeLogger::m_keep_whole_history {false}
privateinherited

◆ m_listCallbacks

std::deque<output_logger_callback_t> mrpt::system::COutputLogger::m_listCallbacks
privateinherited

◆ m_logger_name

std::string mrpt::system::COutputLogger::m_logger_name
privateinherited

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

◆ 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().

◆ m_name

std::string mrpt::system::CTimeLogger::m_name
privateinherited

◆ m_tictac

CTicTac mrpt::system::CTimeLogger::m_tictac
privateinherited
mrpt::system::COutputLogger::logFmt
void logFmt(const VerbosityLevel level, const char *fmt,...) const MRPT_printf_format_check(3
Alternative logging method, which mimics the printf behavior.
Definition: COutputLogger.cpp:91
mrpt::system::COutputLogger::logStr
void logStr(const VerbosityLevel level, std::string_view msg_str) const
Main method to add the specified message string to the logger.
Definition: COutputLogger.cpp:72
mrpt::format
std::string std::string format(std::string_view fmt, ARGS &&... args)
Definition: format.h:26



Page generated by Doxygen 1.8.17 for MRPT 2.0.4 at Sun Jul 19 17:54:30 UTC 2020