Changeset 1102 for trunk/src


Ignore:
Timestamp:
08/02/06 13:16:16 (18 years ago)
Author:
mar637
Message:

added documentation
fixed ifndef

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/src/Logger.h

    r1030 r1102  
    1 #ifndef SDLOG_H
    2 #define SDLOG_H
     1#ifndef ASAPLOGGER_H
     2#define ASAPLOGGER_H
    33
    44#include <string>
    … …  
    66
    77namespace asap {
    8 
     8/**
     9  * This class provides the logging within asap. All other classes which need to log
     10  * should inherit from this.
     11  * @brief The ASAP logging class
     12  * @author Malte Marquarding
     13  * @date $Date$
     14  * @version
     15  */
    916class Logger {
    1017public:
     18  /**
     19   * Default Constructor
     20   **/
    1121  Logger();
     22 
     23  /**
     24   * Constructor with switch to enable/disable logging
     25   * @param[in] enabled indicating the deafult state
     26   */ 
     27  Logger(bool enabled);
     28
     29  /*
     30   * Destructor
     31   */
    1232  virtual ~Logger();
    13   Logger(bool enabled);
     33  /**
     34   * push another message into the logger
     35   * @param[in] the message
     36   * @param[in] whether to add a newline character at the end
     37   */ 
    1438  void pushLog(const std::string& s, bool newline=true) const;
    15   //void pushLog(const char* cs);
     39  /**
     40   * pop the message form the logger
     41   * @returns the log message string
     42   */ 
    1643  std::string popLog() const;
     44  /**
     45   * enable logging
     46   */
    1747  virtual void enableLog();
     48  /**
     49   * disable logging
     50   */
    1851  virtual void disableLog();
     52 
    1953private:
    2054  static std::string log_;
    … …  
    2256};
    2357
    24 }
     58} // namespace
    2559
    2660#endif
Note: See TracChangeset for help on using the changeset viewer.