VcstLogger.h

Go to the documentation of this file.

/**************************************************************************
 *
 * NAME: VcstLogger.h
 *
 * DESCRIPTION: provides logging capabilities for the runtime environment.
 * Debug messages can be set to off, low, medium, or high and can be sent
 * to the console or to a log file.
 *
 * Adapted directly from the IDPS file ProCmnLogger.h published
 * by Raytheon Company.
 *
 **************************************************************************/
 
#ifndef _VcstLogger_H_
#define _VcstLogger_H_
 
#include <fstream>
#include <VcstTime.h>
 
class VcstLogger {
public:
 
    enum Level {
        DBG_OFF = 0, // Disable logging
        DBG_HIGH, // Most basic details
        DBG_MED, // Debugging level
        DBG_LOW // Low-level detail
    };
 
    enum LoggingDest {
        STDOUT = 0, LOGFILE
    };
 
    virtual ~VcstLogger();
 
    void init(VcstLogger::Level level, VcstLogger::LoggingDest dest,
            std::string processName, std::string path = ".");
 
    void init(std::string level, std::string dest, std::string processName,
            std::string path = ".");
 
    static VcstLogger& getLogger();
 
    static VcstLogger* setLogger(VcstLogger* aLogger);
 
    static const char *errorAsStr(int status);
 
    static bool wasError(int status);
 
    bool isDebugHighEnabled();
 
    bool isDebugMedEnabled();
 
    bool isDebugLowEnabled();
 
    void debugHigh(std::string msg, const char* file, const int line);
 
    void debugMed(std::string msg, const char* file, const int line);
 
    void debugLow(std::string msg, const char* file, const int line);
 
    void log(std::string strLog, VcstLogger::Level level, std::string msg,
            const char* file, const int line);
 
    bool isEnabledFor(VcstLogger::Level level);
 
private:
 
    VcstLogger();
 
    VcstLogger(const VcstLogger &orig);
 
    VcstLogger &operator=(const VcstLogger &rhs);
 
    void initLogFile(const std::string& path, const std::string& processName);
 
    void getCurrentHRTime(std::ostringstream& inStream);
 
    VcstTime* timApi_;
 
    std::ostream* outStreamPtr_;
 
    std::ofstream logFile_;
 
    static VcstLogger* ourLogger_;
 
    VcstLogger::Level level_;
 
    VcstLogger::LoggingDest dest_;
 
    bool dbgHighEn_;
 
    bool dbgMedEn_;
 
    bool dbgLowEn_;
 
    static const std::string DEBUG_OFF_STRING;
    static const std::string DEBUG_HIGH_STRING;
    static const std::string DEBUG_MEDIUM_STRING;
    static const std::string DEBUG_LOW_STRING;
 
    static const std::string DEST_STDOUT_STRING;
    static const std::string DEST_LOGFILE_STRING;
};
 
#define DEBUG_HIGH(logger, message) \
                logger.debugHigh(message, __FILE__, __LINE__);
 
#define DEBUG_MED(logger, message) \
                logger.debugMed(message, __FILE__, __LINE__);
 
#define DEBUG_LOW(logger, message) \
                logger.debugLow(message, __FILE__, __LINE__);
 
#endif