PythonLogger.h

Go to the documentation of this file.

// PythonLogger.h:
// ---------------
//

#ifndef __PYIPSDKBASE_PYTHONLOGGER_H__
#define __PYIPSDKBASE_PYTHONLOGGER_H__

#include <Python/PyIPSDKBase/PyIPSDKBaseExports.h>
#include <IPSDKUtil/BaseTypes.h>
#include <IPSDKUtil/Tools/EnumMacros.h>

namespace ipsdk {
namespace python {


IPSDK_ENUM(eLogLevel,
    (eLL_Off)       
    (eLL_Fatal)     
    (eLL_Error)     
    (eLL_Warn)      
    (eLL_Info)      
    (eLL_Debug)     
    (eLL_Trace)     
    (eLL_All)       
    (eLL_Custom)    
)

IPSDK_ENUM(eBaseLogger,
    (eBL_Root)                  
    (eBL_BaseData)              
    (eBL_BaseProcessing)        
    (eBL_BaseShapeAnalysis)     
    (eBL_BaseShapeSegmentation) 
    (eBL_Comm)                  
    (eBL_Core)                  
    (eBL_Geometry)              
    (eBL_Hardware)              
    (eBL_Image)                 
    (eBL_ImageFile)             
    (eBL_ImageProcessing)       
    (eBL_Licensing)             
    (eBL_Math)                  
    (eBL_Serialization)         
    (eBL_Util)                  
)

PYIPSDKBASE_API std::string
getLoggerName(const eBaseLogger& baseLogger);

PYIPSDKBASE_API bool
existsLogger(const std::string& loggerName);

PYIPSDKBASE_API void
setLogLevel(const std::string& loggerName,
            const eLogLevel& logLevel);
PYIPSDKBASE_API void
setLogLevel(const eBaseLogger& baseLogger,
            const eLogLevel& logLevel);

PYIPSDKBASE_API eLogLevel
getLogLevel(const std::string& loggerName);
PYIPSDKBASE_API eLogLevel
getLogLevel(const eBaseLogger& baseLogger);

PYIPSDKBASE_API bool
addFileAppender(const std::string& loggerName,
                const boost::filesystem::path& filePath);
PYIPSDKBASE_API bool
addFileAppender(const std::string& loggerName,
                const boost::filesystem::path& filePath,
                const std::string& layoutStr);
PYIPSDKBASE_API bool
addFileAppender(const eBaseLogger& baseLogger,
                const boost::filesystem::path& filePath);
PYIPSDKBASE_API bool
addFileAppender(const eBaseLogger& baseLogger,
                const boost::filesystem::path& filePath,
                const std::string& layoutStr);

PYIPSDKBASE_API void
removeFileAppender(const std::string& loggerName,
                   const boost::filesystem::path& filePath);
PYIPSDKBASE_API void
removeFileAppender(const eBaseLogger& baseLogger,
                   const boost::filesystem::path& filePath);

PYIPSDKBASE_API void
addConsoleAppender(const std::string& loggerName);
PYIPSDKBASE_API void
addConsoleAppender(const std::string& loggerName,
                   const std::string& layoutStr);
PYIPSDKBASE_API void
addConsoleAppender(const eBaseLogger& baseLogger);
PYIPSDKBASE_API void
addConsoleAppender(const eBaseLogger& baseLogger,
                   const std::string& layoutStr);

PYIPSDKBASE_API void
removeConsoleAppender(const std::string& loggerName);
PYIPSDKBASE_API void
removeConsoleAppender(const eBaseLogger& baseLogger);

PYIPSDKBASE_API void
removeAppenders(const std::string& loggerName);
PYIPSDKBASE_API void
removeAppenders(const eBaseLogger& baseLogger);

PYIPSDKBASE_API void
logFatalMessage(const std::string& messageStr);
PYIPSDKBASE_API void
logErrorMessage(const std::string& messageStr);
PYIPSDKBASE_API void
logWarnMessage(const std::string& messageStr);
PYIPSDKBASE_API void
logInfoMessage(const std::string& messageStr);
PYIPSDKBASE_API void
logDebugMessage(const std::string& messageStr);
PYIPSDKBASE_API void
logTraceMessage(const std::string& messageStr);

PYIPSDKBASE_API void
logMessage(const std::string& loggerName,
           const eLogLevel& logLevel,
           const std::string& messageStr);
PYIPSDKBASE_API void
logMessage(const eBaseLogger& baseLogger,
           const eLogLevel& logLevel,
           const std::string& messageStr);


} // end of namespace python
} // end of namespace ipsdk

#endif // __PYIPSDKBASE_PYTHONLOGGER_H__