Logging.hh File Reference

#include <string>
#include <boost/shared_ptr.hpp>
#include "ldastoolsal/gpstime.hh"
#include "ldastoolsal/Log.hh"
#include "ldastoolsal/Singleton.hh"
#include "ldastoolsal/unordered_map.hh"
#include "genericAPI/LogLDAS.hh"

Include dependency graph for Logging.hh:

Classes
class	GenericAPI::LoggingInfo
class	GenericAPI::Log::StreamFile

Namespaces
	GenericAPI
	GenericAPI::Log

Macros
#define	QUEUE_LOG_MESSAGE(MSG, GROUP, LEVEL, CALLER, JOBINFO)

Typedefs
typedef boost::shared_ptr< GenericAPI::Log::LDAS >	GenericAPI::log_type
typedef Log::LDAS	GenericAPI::LogEntryGroup_type
typedef boost::shared_ptr< StreamFile >	GenericAPI::Log::stream_file_type

Functions
const std::string &	GenericAPI::LogFileDefault ()
	Retrieve the default log file. More...
void	GenericAPI::CloseLog (const std::string &Filename=LogFileDefault())
	Close the requested log. More...
bool	GenericAPI::IsLogging (const int Group, const int Level, const std::string &Filename=LogFileDefault())
	Check if the message would be logged. More...
void	GenericAPI::LogFileDefault (const std::string &LogFilename)
	Establish the default output file for logging. More...
void	GenericAPI::queueLogEntry (const std::string &Message, const std::string &Group, const int Level, const std::string &Caller, const std::string &JobInfo, const unsigned int Time=0, const std::string &Filename=LogFileDefault())
	Queue a message to be written to a log file. More...
void	GenericAPI::queueLogEntry (const std::string &Message, const int Group, const int Level, const std::string &Caller, const std::string &JobInfo, const unsigned int Time=0, const std::string &Filename=LogFileDefault())
	Queue a message to be written to a log file. More...
void	GenericAPI::setLogDebugLevel (const int Level, const std::string &Filename=std::string(""))
	Establish level of debugging output. More...
void	GenericAPI::SetLogFormatter (const GenericAPI::Log::LDAS *Formatter)
	Establish how to format logging messages. More...
log_type	GenericAPI::LogFormatter (const std::string &Filename=LogFileDefault())
	Gain access to the current log formatter. More...
void	GenericAPI::setLogTag (const std::string &Tag)
	Establish tag used to identify logging set. More...
void	GenericAPI::SyncLog (const std::string &Filename=LogFileDefault())
	Wait till all log messages are written. More...

Macro Definition Documentation

QUEUE_LOG_MESSAGE

#define QUEUE_LOG_MESSAGE	(		MSG,
			GROUP,
			LEVEL,
			CALLER,
			JOBINFO
	)

Value:

if ( GenericAPI::IsLogging( GenericAPI::LogEntryGroup_type::GROUP,         \
                                LEVEL ) )                                      \
    {                                                                          \
        std::ostringstream msg;                                                \
        msg << MSG;                                                            \
        GenericAPI::queueLogEntry( msg.str( ),                                 \
                                   GenericAPI::LogEntryGroup_type::GROUP,      \
                                   LEVEL,                                      \
                                   CALLER,                                     \
                                   JOBINFO );                                  \
    }