Main MRPT website > C++ reference
MRPT logo

CDebugOutputCapable.h

Go to the documentation of this file.
00001 /* +---------------------------------------------------------------------------+
00002    |          The Mobile Robot Programming Toolkit (MRPT) C++ library          |
00003    |                                                                           |
00004    |                   http://mrpt.sourceforge.net/                            |
00005    |                                                                           |
00006    |   Copyright (C) 2005-2011  University of Malaga                           |
00007    |                                                                           |
00008    |    This software was written by the Machine Perception and Intelligent    |
00009    |      Robotics Lab, University of Malaga (Spain).                          |
00010    |    Contact: Jose-Luis Blanco  <jlblanco@ctima.uma.es>                     |
00011    |                                                                           |
00012    |  This file is part of the MRPT project.                                   |
00013    |                                                                           |
00014    |     MRPT is free software: you can redistribute it and/or modify          |
00015    |     it under the terms of the GNU General Public License as published by  |
00016    |     the Free Software Foundation, either version 3 of the License, or     |
00017    |     (at your option) any later version.                                   |
00018    |                                                                           |
00019    |   MRPT is distributed in the hope that it will be useful,                 |
00020    |     but WITHOUT ANY WARRANTY; without even the implied warranty of        |
00021    |     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         |
00022    |     GNU General Public License for more details.                          |
00023    |                                                                           |
00024    |     You should have received a copy of the GNU General Public License     |
00025    |     along with MRPT.  If not, see <http://www.gnu.org/licenses/>.         |
00026    |                                                                           |
00027    +---------------------------------------------------------------------------+ */
00028 #ifndef  CDebugOutputCapable_H
00029 #define  CDebugOutputCapable_H
00030 
00031 #include <mrpt/utils/utils_defs.h>
00032 #include <mrpt/utils/CStream.h>
00033 
00034 /*---------------------------------------------------------------
00035         Class
00036   ---------------------------------------------------------------*/
00037 namespace mrpt
00038 {
00039         namespace utils
00040         {
00041                 /** This base class provides a common printf-like method to send debug information to std::cout, with the purpose of allowing its redirection to other streams if desired.
00042                   *  By default, messages sent to "printf_debug" will be shown in the console (cout) and also in 
00043                   *   the stream passed to debugOutputSetStream, but the console output can be
00044                   *   switched off with debugOutputEnableConsole(false).
00045                   *
00046                   *  In addition, this class will send all the messages from "printf_debug" to the Visual Studio "Output Window" in debug mode (obviously, this is a feature only enabled under Windows).
00047                   *
00048                   *  See CDebugOutputCapable::printf_debug.
00049                  */
00050                 class BASE_IMPEXP CDebugOutputCapable
00051                 {
00052                 public:
00053                         /** Default initialization */
00054                         CDebugOutputCapable() { }
00055                         virtual ~CDebugOutputCapable() { }
00056 
00057                         /** Sends a formated text to "debugOut" if not NULL, or to cout otherwise. */
00058                         static void printf_debug( const char *frmt, ... );
00059 
00060                 }; // End of class def.
00061 
00062         } // End of namespace
00063 } // end of namespace
00064 #endif



Page generated by Doxygen 1.7.3 for MRPT 0.9.4 SVN:exported at Tue Jan 25 21:56:31 UTC 2011