RTC::basic_logstream< _CharT, _Traits > Class Template Reference

Logger format class. More...

#include <SystemLogger.h>

List of all members.

Public Types

enum  {
  RTL_SILENT, RTL_ERROR, RTL_WARN, RTL_INFO,
  RTL_NORMAL, RTL_DEBUG, RTL_TRACE, RTL_VERBOSE,
  RTL_PARANOID, RTL_MANDATORY
}
typedef _CharT char_type
typedef _Traits traits_type
typedef basic_logbuf
< char_type,
traits_type
__logbuf_type
typedef
basic_dummybuf
< char_type,
traits_type
__dummybuf_type
typedef
basic_logstream
< char_type,
traits_type
__logstream_type
typedef
std::basic_ostream
< char_type,
traits_type
__ostream_type
typedef
std::basic_streambuf
< char_type,
traits_type
__streambuf_type

Public Member Functions

 basic_logstream (__streambuf_type &streambuf)
 Constructor.
 ~basic_logstream ()
 Destructor.
void setLogLevel (const std::string &level)
 Set the log level.
void setLogLevel (int level)
 Set the log level.
void setLogLock (bool lock)
 Set the lock mode.
void enableLogLock ()
 Enable the lock mode.
void disableLogLock ()
 Disable the lock mode.
__ostream_typelevel (int level)
 Acquire log stream.
void acquire ()
 Acquire log lock Acquire log lock when the lock mode is set.
void release ()
 Release the log lock Release the log lock when the lock mode is set.

Static Public Member Functions

static int strToLogLevel (const std::string &lv)
 Set the log level.
static std::string printf (char const *__restrict fmt,...)
 Formatted output like printf.

Public Attributes

__ostream_type m_DummyStream
 Dummy log.


Detailed Description

template<typename _CharT, typename _Traits = std::char_traits<_CharT>>
class RTC::basic_logstream< _CharT, _Traits >

Logger format class.

This is a logger format class like basic_ostream.


Member Typedef Documentation

template<typename _CharT, typename _Traits = std::char_traits<_CharT>>
typedef _CharT RTC::basic_logstream< _CharT, _Traits >::char_type

template<typename _CharT, typename _Traits = std::char_traits<_CharT>>
typedef _Traits RTC::basic_logstream< _CharT, _Traits >::traits_type

template<typename _CharT, typename _Traits = std::char_traits<_CharT>>
typedef basic_logbuf<char_type, traits_type> RTC::basic_logstream< _CharT, _Traits >::__logbuf_type

template<typename _CharT, typename _Traits = std::char_traits<_CharT>>
typedef basic_dummybuf<char_type, traits_type> RTC::basic_logstream< _CharT, _Traits >::__dummybuf_type

template<typename _CharT, typename _Traits = std::char_traits<_CharT>>
typedef basic_logstream<char_type, traits_type> RTC::basic_logstream< _CharT, _Traits >::__logstream_type

template<typename _CharT, typename _Traits = std::char_traits<_CharT>>
typedef std::basic_ostream<char_type, traits_type> RTC::basic_logstream< _CharT, _Traits >::__ostream_type

template<typename _CharT, typename _Traits = std::char_traits<_CharT>>
typedef std::basic_streambuf<char_type, traits_type> RTC::basic_logstream< _CharT, _Traits >::__streambuf_type


Member Enumeration Documentation

template<typename _CharT, typename _Traits = std::char_traits<_CharT>>
anonymous enum

Enumerator:
RTL_SILENT 
RTL_ERROR 
RTL_WARN 
RTL_INFO 
RTL_NORMAL 
RTL_DEBUG 
RTL_TRACE 
RTL_VERBOSE 
RTL_PARANOID 
RTL_MANDATORY 


Constructor & Destructor Documentation

template<typename _CharT, typename _Traits = std::char_traits<_CharT>>
RTC::basic_logstream< _CharT, _Traits >::basic_logstream ( __streambuf_type streambuf  )  [inline]

Constructor.

Constructor

Parameters:
streambuf basic_streambuf type object

template<typename _CharT, typename _Traits = std::char_traits<_CharT>>
RTC::basic_logstream< _CharT, _Traits >::~basic_logstream (  )  [inline]

Destructor.

Destructor


Member Function Documentation

template<typename _CharT, typename _Traits = std::char_traits<_CharT>>
static int RTC::basic_logstream< _CharT, _Traits >::strToLogLevel ( const std::string &  lv  )  [inline, static]

Set the log level.

Set the log level corresponding to the given string.

Parameters:
lv Log level string
Returns:
The set log level

template<typename _CharT, typename _Traits = std::char_traits<_CharT>>
static std::string RTC::basic_logstream< _CharT, _Traits >::printf ( char const *__restrict  fmt,
  ... 
) [inline, static]

Formatted output like printf.

Output a log with a format like printf.

Parameters:
fmt Formatted string
Returns:
Formatted string output

template<typename _CharT, typename _Traits = std::char_traits<_CharT>>
void RTC::basic_logstream< _CharT, _Traits >::setLogLevel ( const std::string &  level  )  [inline]

Set the log level.

Set the log level corresponding to the given string.

Parameters:
level Log level string

template<typename _CharT, typename _Traits = std::char_traits<_CharT>>
void RTC::basic_logstream< _CharT, _Traits >::setLogLevel ( int  level  )  [inline]

Set the log level.

Set the log level.

Parameters:
level Log level

template<typename _CharT, typename _Traits = std::char_traits<_CharT>>
void RTC::basic_logstream< _CharT, _Traits >::setLogLock ( bool  lock  )  [inline]

Set the lock mode.

Set the lock mode of log.

Parameters:
lock Flag of log lock

template<typename _CharT, typename _Traits = std::char_traits<_CharT>>
void RTC::basic_logstream< _CharT, _Traits >::enableLogLock (  )  [inline]

Enable the lock mode.

Enable the lock mode.

template<typename _CharT, typename _Traits = std::char_traits<_CharT>>
void RTC::basic_logstream< _CharT, _Traits >::disableLogLock (  )  [inline]

Disable the lock mode.

Disable the lock mode.

template<typename _CharT, typename _Traits = std::char_traits<_CharT>>
__ostream_type& RTC::basic_logstream< _CharT, _Traits >::level ( int  level  )  [inline]

Acquire log stream.

Investigate the specified log level and get its log stream. If the specified log level is under the set log level, this class will be returned. If the specified log level exceeds the set log level, a dummy log class will be returned.

Parameters:
level The specified log level
Returns:
Target log stream

template<typename _CharT, typename _Traits = std::char_traits<_CharT>>
void RTC::basic_logstream< _CharT, _Traits >::acquire (  )  [inline]

Acquire log lock Acquire log lock when the lock mode is set.

template<typename _CharT, typename _Traits = std::char_traits<_CharT>>
void RTC::basic_logstream< _CharT, _Traits >::release (  )  [inline]

Release the log lock Release the log lock when the lock mode is set.


Member Data Documentation

template<typename _CharT, typename _Traits = std::char_traits<_CharT>>
__ostream_type RTC::basic_logstream< _CharT, _Traits >::m_DummyStream

Dummy log.


Generated on Wed May 21 05:17:34 2008 for OpenRTM by  doxygen 1.5.3