Main MRPT website > C++ reference for MRPT 1.9.9
List of all members | Public Member Functions | Public Attributes | Static Public Attributes | Protected Attributes | Private Member Functions | Private Attributes
mrpt::graphslam::CWindowManager Class Reference

Detailed Description

Class acts as a container for storing pointers to mrpt::gui::CDisplayWindow3D, mrpt::graphslam::CWindowObserver instances.

CWindowManager also provides methods for adding/positioning textMessages and viewports in the CDisplayWindow in a compact and consistent way.

Definition at line 30 of file CWindowManager.h.

#include <mrpt/graphslam/misc/CWindowManager.h>

Inheritance diagram for mrpt::graphslam::CWindowManager:
Inheritance graph

Public Member Functions

 CWindowManager ()
 Default class constructor. More...
 
 CWindowManager (mrpt::gui::CDisplayWindow3D *win_in)
 Class constructor. More...
 
 CWindowManager (mrpt::gui::CDisplayWindow3D *win_in, mrpt::graphslam::CWindowObserver *observer_in)
 Class constructor. More...
 
 ~CWindowManager ()
 Class destructor. More...
 
void setCDisplayWindow3DPtr (mrpt::gui::CDisplayWindow3D *win_in)
 Store the CDisplayWindow3D pointer in the CWindowManager instance. More...
 
void setWindowObserverPtr (mrpt::graphslam::CWindowObserver *obsever_in)
 Store the CWindowObserver pointer in the CWindowManager instance. More...
 
void assignTextMessageParameters (double *offset_y, int *text_index)
 Assign the next available offset_y and text_index for the textMessage under construction. More...
 
bool isOpen ()
 Wrapper call around the CWindowDisplay3D. More...
 
void addTextMessage (const double x, const double y, const std::string &text, const mrpt::img::TColorf &color=mrpt::img::TColorf(1.0, 1.0, 1.0), const size_t unique_index=0)
 Wrapper around the CDisplayWindow3D::addTextMessage method, so that the user does not have to specify the font name and size. More...
 
void assignViewportParameters (double *x, double *y, double *width, double *height)
 Assign position and size values for the placement of the next viewport. More...
 

Public Attributes

mrpt::gui::CDisplayWindow3Dwin
 CDisplayWindow instance. More...
 
mrpt::graphslam::CWindowObserverobserver
 CWindowObserver instance. More...
 

Static Public Attributes

static mrpt::system::TConsoleColor logging_levels_to_colors [NUMBER_OF_VERBOSITY_LEVELS]
 Map from VerbosityLevels to their corresponding mrpt::system::TConsoleColor. More...
 
static std::string logging_levels_to_names [NUMBER_OF_VERBOSITY_LEVELS]
 Map from VerbosityLevels to their corresponding names. More...
 

Protected Attributes

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

Private Member Functions

void initCWindowManager ()
 Initialization method, to be called from the various Constructors. More...
 

Private Attributes

bool m_fetched_observer_pointer
 
bool m_fetched_displaywindow_pointer
 
double m_offset_y_step
 
int m_index_text_step
 
double m_curr_offset_y
 
int m_curr_text_index
 
std::string m_font_name
 
int m_font_size
 
double m_viewp_width
 
double m_viewp_height
 
double m_viewp_x
 
double m_viewp_y
 vertical layout of the viewports More...
 
double m_viewp_margin
 

Logging methods

bool logging_enable_console_output
 [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
 [Default=false] Enables storing all messages into an internal list. More...
 
void logStr (const VerbosityLevel level, const std::string &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=NULL) 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)
 

Constructor & Destructor Documentation

◆ CWindowManager() [1/3]

mrpt::graphslam::CWindowManager::CWindowManager ( )
inline

Default class constructor.

Definition at line 34 of file CWindowManager.h.

References initCWindowManager().

◆ CWindowManager() [2/3]

mrpt::graphslam::CWindowManager::CWindowManager ( mrpt::gui::CDisplayWindow3D win_in)
inline

Class constructor.

Definition at line 36 of file CWindowManager.h.

References initCWindowManager(), and setCDisplayWindow3DPtr().

◆ CWindowManager() [3/3]

mrpt::graphslam::CWindowManager::CWindowManager ( mrpt::gui::CDisplayWindow3D win_in,
mrpt::graphslam::CWindowObserver observer_in 
)
inline

Class constructor.

Definition at line 42 of file CWindowManager.h.

References initCWindowManager(), setCDisplayWindow3DPtr(), and setWindowObserverPtr().

◆ ~CWindowManager()

mrpt::graphslam::CWindowManager::~CWindowManager ( )
inline

Class destructor.

Definition at line 52 of file CWindowManager.h.

Member Function Documentation

◆ addTextMessage()

void mrpt::graphslam::CWindowManager::addTextMessage ( const double  x,
const double  y,
const std::string text,
const mrpt::img::TColorf color = mrpt::img::TColorf(1.0, 1.0, 1.0),
const size_t  unique_index = 0 
)
inline

Wrapper around the CDisplayWindow3D::addTextMessage method, so that the user does not have to specify the font name and size.

Note
see initCWindowManager method for the default fontName and fontSize used.

Definition at line 114 of file CWindowManager.h.

References mrpt::gui::CDisplayWindow3D::addTextMessage(), m_font_name, m_font_size, mrpt::opengl::NICE, and win.

Referenced by mrpt::graphslam::detail::CEdgeCounter::updateTextMessages().

◆ assignTextMessageParameters()

void mrpt::graphslam::CWindowManager::assignTextMessageParameters ( double *  offset_y,
int *  text_index 
)
inline

Assign the next available offset_y and text_index for the textMessage under construction.

Used for consistent positioning of textMessages in the CDisplayWindow3D.

See also
assignViewPortParameters

Definition at line 85 of file CWindowManager.h.

References m_curr_offset_y, m_curr_text_index, m_index_text_step, and m_offset_y_step.

◆ assignViewportParameters()

void mrpt::graphslam::CWindowManager::assignViewportParameters ( double *  x,
double *  y,
double *  width,
double *  height 
)
inline

Assign position and size values for the placement of the next viewport.

Used for consistent positioning of the Viewports in the CDisplayWindow3D

See also
assignTextMessageParameters

Definition at line 136 of file CWindowManager.h.

References m_viewp_height, m_viewp_margin, m_viewp_width, m_viewp_x, and m_viewp_y.

◆ dumpLogToConsole()

void COutputLogger::dumpLogToConsole ( ) const
inherited

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

See also
writeToFile

Definition at line 179 of file COutputLogger.cpp.

◆ 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 143 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 148 of file COutputLogger.cpp.

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

◆ getLoggerLastMsg() [1/2]

std::string COutputLogger::getLoggerLastMsg ( ) const
inherited

Return the last Tmsg instance registered in the logger history.

Definition at line 184 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 190 of file COutputLogger.cpp.

◆ getLoggerName()

std::string COutputLogger::getLoggerName ( ) const
inherited

Return the name of the COutputLogger instance.

See also
setLoggerName

Definition at line 132 of file COutputLogger.cpp.

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

◆ getMinLoggingLevel()

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

◆ initCWindowManager()

void mrpt::graphslam::CWindowManager::initCWindowManager ( )
inlineprivate

◆ isLoggingLevelVisible()

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

◆ isOpen()

bool mrpt::graphslam::CWindowManager::isOpen ( )
inline

Wrapper call around the CWindowDisplay3D.

Definition at line 95 of file CWindowManager.h.

References mrpt::gui::CBaseGUIWindow::isOpen(), and win.

◆ 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 120 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 287 of file COutputLogger.cpp.

References getAddress().

◆ 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 195 of file COutputLogger.cpp.

References mrpt::system::LVL_INFO.

◆ logRegisterCallback()

void COutputLogger::logRegisterCallback ( output_logger_callback_t  userFunc)
inherited

Definition at line 274 of file COutputLogger.cpp.

◆ logStr()

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

◆ setCDisplayWindow3DPtr()

void mrpt::graphslam::CWindowManager::setCDisplayWindow3DPtr ( mrpt::gui::CDisplayWindow3D win_in)
inline

Store the CDisplayWindow3D pointer in the CWindowManager instance.

See also
setWindowObserverPtr

Definition at line 58 of file CWindowManager.h.

References m_fetched_displaywindow_pointer, MRPT_LOG_DEBUG_STREAM, and win.

Referenced by CWindowManager(), and CGraphSlamHandler< GRAPH_T >::initVisualization().

◆ 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 133 of file COutputLogger.cpp.

Referenced by mrpt::maps::CRandomFieldGridMap2D::enableVerbose(), mrpt::math::CLevenbergMarquardtTempl< VECTORTYPE, USERPARAM >::execute(), mrpt::hwdrivers::CHokuyoURG::initialize(), and mrpt::graphslam::deciders::CICPCriteriaNRD< GRAPH_T >::loadParams().

◆ setVerbosityLevel()

void COutputLogger::setVerbosityLevel ( const VerbosityLevel  level)
inherited

◆ setWindowObserverPtr()

void mrpt::graphslam::CWindowManager::setWindowObserverPtr ( mrpt::graphslam::CWindowObserver obsever_in)
inline

◆ writeLogToFile()

void COutputLogger::writeLogToFile ( const std::string fname_in = NULL) 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 154 of file COutputLogger.cpp.

References ASSERTMSG_, and mrpt::format().

Member Data Documentation

◆ logging_enable_console_output

bool mrpt::system::COutputLogger::logging_enable_console_output
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 239 of file system/COutputLogger.h.

◆ logging_enable_keep_record

bool mrpt::system::COutputLogger::logging_enable_keep_record
inherited

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

See also
writeLogToFile, getLogAsString

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

◆ logging_levels_to_colors

mrpt::system::TConsoleColor COutputLogger::logging_levels_to_colors
staticinherited
Initial value:

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

Implementation file for the COutputLogger header class.

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

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

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

◆ logging_levels_to_names

std::string COutputLogger::logging_levels_to_names
staticinherited
Initial value:
=
{
"DEBUG",
"INFO ",
"WARN ",
"ERROR"
}

Map from VerbosityLevels to their corresponding names.

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

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

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

◆ m_curr_offset_y

double mrpt::graphslam::CWindowManager::m_curr_offset_y
private

Definition at line 183 of file CWindowManager.h.

Referenced by assignTextMessageParameters(), and initCWindowManager().

◆ m_curr_text_index

int mrpt::graphslam::CWindowManager::m_curr_text_index
private

Definition at line 184 of file CWindowManager.h.

Referenced by assignTextMessageParameters(), and initCWindowManager().

◆ m_fetched_displaywindow_pointer

bool mrpt::graphslam::CWindowManager::m_fetched_displaywindow_pointer
private

Definition at line 179 of file CWindowManager.h.

Referenced by initCWindowManager(), and setCDisplayWindow3DPtr().

◆ m_fetched_observer_pointer

bool mrpt::graphslam::CWindowManager::m_fetched_observer_pointer
private

Definition at line 178 of file CWindowManager.h.

Referenced by initCWindowManager(), and setWindowObserverPtr().

◆ m_font_name

std::string mrpt::graphslam::CWindowManager::m_font_name
private

Definition at line 186 of file CWindowManager.h.

Referenced by addTextMessage(), and initCWindowManager().

◆ m_font_size

int mrpt::graphslam::CWindowManager::m_font_size
private

Definition at line 187 of file CWindowManager.h.

Referenced by addTextMessage(), and initCWindowManager().

◆ m_index_text_step

int mrpt::graphslam::CWindowManager::m_index_text_step
private

Definition at line 182 of file CWindowManager.h.

Referenced by assignTextMessageParameters(), and initCWindowManager().

◆ m_min_verbosity_level

VerbosityLevel mrpt::system::COutputLogger::m_min_verbosity_level
protectedinherited

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

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

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

◆ m_offset_y_step

double mrpt::graphslam::CWindowManager::m_offset_y_step
private

Definition at line 181 of file CWindowManager.h.

Referenced by assignTextMessageParameters(), and initCWindowManager().

◆ m_viewp_height

double mrpt::graphslam::CWindowManager::m_viewp_height
private

Definition at line 191 of file CWindowManager.h.

Referenced by assignViewportParameters(), and initCWindowManager().

◆ m_viewp_margin

double mrpt::graphslam::CWindowManager::m_viewp_margin
private

Definition at line 194 of file CWindowManager.h.

Referenced by assignViewportParameters(), and initCWindowManager().

◆ m_viewp_width

double mrpt::graphslam::CWindowManager::m_viewp_width
private

Definition at line 190 of file CWindowManager.h.

Referenced by assignViewportParameters(), and initCWindowManager().

◆ m_viewp_x

double mrpt::graphslam::CWindowManager::m_viewp_x
private

Definition at line 192 of file CWindowManager.h.

Referenced by assignViewportParameters(), and initCWindowManager().

◆ m_viewp_y

double mrpt::graphslam::CWindowManager::m_viewp_y
private

vertical layout of the viewports

Definition at line 193 of file CWindowManager.h.

Referenced by assignViewportParameters(), and initCWindowManager().

◆ observer

mrpt::graphslam::CWindowObserver* mrpt::graphslam::CWindowManager::observer

CWindowObserver instance.

Definition at line 149 of file CWindowManager.h.

Referenced by initCWindowManager(), and setWindowObserverPtr().

◆ win

mrpt::gui::CDisplayWindow3D* mrpt::graphslam::CWindowManager::win



Page generated by Doxygen 1.8.14 for MRPT 1.9.9 Git: ad3a9d8ae Tue May 1 23:10:22 2018 -0700 at lun oct 28 00:14:14 CET 2019