WURDE: Logger Class Reference

Please read the documentation for RobotObjects for other important functions. Data structures will be placed behind accessor functions in the future.

Definition at line 53 of file Logger.H.


Public Member Functions
	Logger (std::string somename)
	Normal constructor.
	Logger (std::string somename, std::string filename)
	Constructor for logging to file as well as other methods.
	~Logger ()
void	initLogger ()
void	log (std::string somestring, int priority)
	Totally experimental.
void	debug (std::string somestring)
	Short version for debug logging.
void	info (std::string somestring)
	Short version for info logging.
void	notice (std::string somestring)
	Short version for notice logging.
void	warn (std::string somestring)
	Short version for warn logging.
void	error (std::string somestring)
	Short version for error logging.
void	fatal (std::string somestring)
	Short version for fatal logging.
void	log (std::string somestring)
	Basic logging function.
void	setNetworkLogging (bool value)
	Specify whether or not to log to the network.
void	setSysLogging (bool value)
	Specify whether or not to log to syslog.
void	setStderr (bool value)
	Specify whether or not syslog should send to stderr.
void	logData (std::string description, std::string format, std::string data)
	DO NOT USE THIS FUNCTION.
void	setLogLevel (int priority)
	Sets the loglevel to start logging.
Private Member Functions
void	init (std::string somename)
Private Attributes
std::string	m_outFilename
bool	m_toFile
bool	m_toNetwork
bool	m_toSyslog
bool	m_toStderr
int	m_logLevel
bool	m_init
std::string	m_logName
pthread_mutex_t	mutex

Constructor & Destructor Documentation

Logger ( std::string somename )

Normal constructor.

Please use this one.

Definition at line 45 of file Logger.cpp.

References WURDE::g_robotLoggerPtr, Logger::m_init, Logger::m_logLevel, Logger::m_logName, Logger::m_toFile, Logger::m_toNetwork, Logger::m_toStderr, Logger::m_toSyslog, LoggerTransport::setGlobalName(), Logger::setNetworkLogging(), Logger::setStderr(), and Logger::setSysLogging().

Logger	(	std::string	somename,
		std::string	filename
	)

Constructor for logging to file as well as other methods.

Best not to use this now, as file logging isn't complete.

Definition at line 68 of file Logger.cpp.

References WURDE::g_robotLoggerPtr, Logger::m_init, Logger::m_logName, Logger::m_outFilename, Logger::m_toFile, Logger::m_toNetwork, Logger::m_toStderr, Logger::m_toSyslog, LoggerTransport::setGlobalName(), Logger::setNetworkLogging(), Logger::setStderr(), and Logger::setSysLogging().

~Logger ( ) [inline]

Definition at line 67 of file Logger.H.

Member Function Documentation

void initLogger ( )

Definition at line 91 of file Logger.cpp.

References WURDE::g_globalConfiguration, WURDEConfiguration::getLogLevel(), Logger::m_init, Logger::m_logLevel, and Logger::mutex.

Referenced by Logger::log().

void log	(	std::string	somestring,
		int	priority
	)

Totally experimental.

This function includes a priority. Use the syslog priorities with it. They are: LOG_EMERG system is unusable, LOG_ALERT action must be taken immediately, LOG_CRIT critical conditions, LOG_ERR error conditions, LOG_WARNING warning conditions, LOG_NOTICE normal, but significant, condition, LOG_INFO informational message, LOG_DEBUG debug-level message.

In general, only use DEBUG through ERR. Use CRIT if it is a fatal condition.

NOTE: It is up to YOU to exit if a fatal condition is reached. The logging system should not kill the process.

A newline is appended to the logged string.

Note that the facility value for syslog will be set to local0. ident for syslog will be set to "Robot" and the actual module name is prepended by the logger.

Definition at line 109 of file Logger.cpp.

References LoggerTransport::data, Logger::initLogger(), LoggerTransportDataStruct::logData, LoggerTransportDataStruct::logFormat, LoggerTransportDataStruct::logString, Logger::m_init, Logger::m_logLevel, Logger::m_logName, Logger::m_toFile, Logger::m_toNetwork, Logger::m_toSyslog, Logger::mutex, LoggerTransportDataStruct::priority, WURDE::priorityToString(), LoggerTransport::publishData(), and LoggerTransport::runUpdate().