Gaudi Framework, version v22r1
Home   Generated: Mon Feb 28 2011
Public Member Functions | Protected Attributes | Private Types

MsgStream Class Reference

Definition of the MsgStream class used to transmit messages. More...

#include <GaudiKernel/MsgStream.h>

Collaboration diagram for MsgStream:
Collaboration graph
[legend]

List of all members.

Public Member Functions

GAUDI_API MsgStream (IMessageSvc *svc, int buffer_length=128)
 Standard constructor: Connect to message service for output.
GAUDI_API MsgStream (IMessageSvc *svc, const std::string &source, int buffer_length=128)
 Standard constructor: Connect to message service for output.
 MsgStream (const MsgStream &msg)
 Copy constructor.
virtual GAUDI_API ~MsgStream ()
 Standard destructor.
MsgStream & report (int lvl)
 Initialize report of new message: activate if print level is sufficient.
virtual GAUDI_API MsgStream & doOutput ()
 Output method.
const std::string & buffer () const
 Access string buffer.
std::ostringstream & stream ()
 Access string MsgStream.
void setMsgSvc (IMessageSvc *svc)
 Update IMessageSvc pointer.
void setLevel (int level)
 Update outputlevel.
MSG::Level level ()
 Retrieve output level.
MSG::Level currentLevel ()
 Retrieve current stream output level.
void activate ()
 Activate MsgStream.
void deactivate ()
 Deactivate MsgStream.
bool isActive () const
 Accessor: is MsgStream active.
MsgStream & flush ()
MsgStream & write (const char *buff, int len)
MsgStream & operator<< (MsgStream &(*_f)(MsgStream &))
 Accept MsgStream modifiers.
MsgStream & operator<< (std::ostream &(*_f)(std::ostream &))
 Accept oMsgStream modifiers.
MsgStream & operator<< (std::ios &(*_f)(std::ios &))
 Accept ios modifiers.
MsgStream & operator<< (MSG::Level level)
 Accept MsgStream activation using MsgStreamer operator.
MsgStream & operator<< (longlong arg)
MsgStream & operator<< (std::ios_base &(*_f)(std::ios_base &))
 Accept ios base class modifiers.
long flags () const
 IOS emulation.
long flags (FLAG_TYPE v)
long setf (FLAG_TYPE v)
int width () const
int width (int v)
char fill () const
char fill (char v)
int precision () const
int precision (int v)
int rdstate () const
int good () const
int eof () const
int bad () const
long setf (FLAG_TYPE _f, FLAG_TYPE _m)
void unsetf (FLAG_TYPE _l)
void clear (STATE_TYPE _i=std::ios_base::failbit)
GAUDI_API void setColor (MSG::Color col)
 Set the text color.
GAUDI_API void setColor (MSG::Color fg, MSG::Color bg)
 Set the foreground and background colors.
GAUDI_API void resetColor ()
 Reset the colors to defaults.

Protected Attributes

IMessageSvc * m_service
 Pointer to message service if buffer has send.
std::string m_buffer
 Use standard string for information buffering.
std::string m_source
 Use std::string for source information to be passed to the message service.
std::ostringstream m_stream
 String MsgStream associated to buffer.
bool m_active
 Flag set to true if formatting engine is active.
MSG::Level m_level
 Debug level of the message service.
MSG::Level m_currLevel
 Current debug level.
bool m_useColors
 use colors

Private Types

typedef std::ios_base::fmtflags FLAG_TYPE
 Error return code in case ios modification is requested for inactive streams.
typedef std::ios_base::iostate STATE_TYPE

Detailed Description

Definition of the MsgStream class used to transmit messages.

This class is intended to ease the use of error logging to the message service

Author:
M.Frank
Sebastien Ponce

Definition at line 25 of file MsgStream.h.

Member Typedef Documentation

typedef std::ios_base::fmtflags MsgStream::FLAG_TYPE [private]

Error return code in case ios modification is requested for inactive streams.

Definition at line 30 of file MsgStream.h.

typedef std::ios_base::iostate MsgStream::STATE_TYPE [private]

Definition at line 31 of file MsgStream.h.

Constructor & Destructor Documentation

MsgStream::MsgStream ( IMessageSvc *  svc,
int  buffer_length = 128 
)

Standard constructor: Connect to message service for output.

Definition at line 31 of file MsgStream.cpp.

: m_service(svc),
  m_source(""),
  m_active(false)
{
  setLevel((0==svc) ? MSG::INFO : svc->outputLevel());
  m_useColors = (0==svc) ? false : svc->useColor();
}
MsgStream::MsgStream ( IMessageSvc *  svc,
const std::string &  source,
int  buffer_length = 128 
)

Standard constructor: Connect to message service for output.

Definition at line 40 of file MsgStream.cpp.

: m_service(svc),
  m_source(source),
  m_active(false)
{
  setLevel((0==svc) ? MSG::INFO : svc->outputLevel(source));
  m_useColors = (0==svc) ? false : svc->useColor();
}
MsgStream::MsgStream ( const MsgStream &  msg ) [inline]

Copy constructor.

Definition at line 55 of file MsgStream.h.

    : m_service(msg.m_service),
      m_active(msg.m_active),
      m_level(msg.m_level),
      m_useColors(msg.m_useColors)
  {
    try { // ignore exception if we cannot copy the string
      m_source = msg.m_source;
    }
    catch (...) {}
  }
MsgStream::~MsgStream (  ) [virtual]

Standard destructor.

Definition at line 49 of file MsgStream.cpp.

                         {
}

Member Function Documentation

void MsgStream::activate (  ) [inline]

Activate MsgStream.

Definition at line 104 of file MsgStream.h.

                      {
    m_active = true;
  }
int MsgStream::bad (  ) const [inline]

Definition at line 205 of file MsgStream.h.

                   {
    return isActive() ? m_stream.bad()      : 0;
  }
const std::string& MsgStream::buffer (  ) const [inline]

Access string buffer.

Definition at line 78 of file MsgStream.h.

                                  {
    return m_buffer;
  }
void MsgStream::clear ( STATE_TYPE  _i = std::ios_base::failbit ) [inline]

Definition at line 214 of file MsgStream.h.

                                                  {
    if ( isActive() ) m_stream.clear(_i);
  }
MSG::Level MsgStream::currentLevel (  ) [inline]

Retrieve current stream output level.

Definition at line 100 of file MsgStream.h.

                            {
    return m_currLevel;
  }
void MsgStream::deactivate (  ) [inline]

Deactivate MsgStream.

Definition at line 108 of file MsgStream.h.

                        {
    m_active = false;
  }
MsgStream & MsgStream::doOutput (  ) [virtual]

Output method.

Definition at line 52 of file MsgStream.cpp.

                                     {
  try {
    // This piece of code may throw and we cannot afford it when we print a message
    // in the middle of a catch block.
    if ( isActive() )   {
      Message msg(m_source,m_currLevel,m_stream.str());
      if ( m_service != 0 )   {
        m_service->reportMessage (msg, m_currLevel);
      }
      else     {
        std::cout << msg << std::endl;
      }
    }
    m_stream.str("");
  } catch(...) {}
  return *this;
}
int MsgStream::eof (  ) const [inline]

Definition at line 202 of file MsgStream.h.

                   {
    return isActive() ? m_stream.eof ()     : 0;
  }
char MsgStream::fill (  ) const [inline]

Definition at line 184 of file MsgStream.h.

                    {
    return isActive() ? m_stream.fill()     : (char)-1;
  }
char MsgStream::fill ( char  v ) [inline]

Definition at line 187 of file MsgStream.h.

                    {
    return isActive() ? m_stream.fill(v)     : (char)-1;
  }
long MsgStream::flags (  ) const [inline]

IOS emulation.

Definition at line 169 of file MsgStream.h.

                     {
    return isActive() ? m_stream.flags()    : 0;
  }
long MsgStream::flags ( FLAG_TYPE  v ) [inline]

Definition at line 172 of file MsgStream.h.

                          {
    return isActive() ? m_stream.flags(v)  :  0;
  }
MsgStream& MsgStream::flush (  ) [inline]

Definition at line 116 of file MsgStream.h.

                        {
    if ( isActive() ) m_stream.flush();
    return *this;
  }
int MsgStream::good (  ) const [inline]

Definition at line 199 of file MsgStream.h.

                    {
    return isActive() ? m_stream.good ()    : 0;
  }
bool MsgStream::isActive (  ) const [inline]

Accessor: is MsgStream active.

Definition at line 112 of file MsgStream.h.

                           {
    return m_active;
  }
MSG::Level MsgStream::level (  ) [inline]

Retrieve output level.

Definition at line 96 of file MsgStream.h.

                     {
    return m_level;
  }
MsgStream& MsgStream::operator<< ( std::ios &(*)(std::ios &)  _f ) [inline]

Accept ios modifiers.

Definition at line 136 of file MsgStream.h.

                                                   {
    if ( isActive() ) _f(m_stream);
    return *this;
  }
MsgStream& MsgStream::operator<< ( MSG::Level  level ) [inline]

Accept MsgStream activation using MsgStreamer operator.

Definition at line 141 of file MsgStream.h.

                                          {
    return report(level);
  }
MsgStream& MsgStream::operator<< ( longlong  arg ) [inline]

Definition at line 144 of file MsgStream.h.

                                      {
    try {
      // this may throw, and we cannot afford it if the stream is used in a catch block
      if(isActive()) {
#ifdef _WIN32
        int flg = m_stream.flags();
        char buf[128];
        (flg & std::ios::hex) ?
          ::sprintf(buf,"%I64x",arg) : ::sprintf(buf,"%I64d",arg);
        m_stream << buf;
#else
        m_stream << arg;
#endif
      }
    } catch (...) {}
    return *this;
  }
MsgStream& MsgStream::operator<< ( std::ios_base &(*)(std::ios_base &)  _f ) [inline]

Accept ios base class modifiers.

Definition at line 163 of file MsgStream.h.

                                                             {
    if ( isActive() ) _f(m_stream);
    return *this;
  }
MsgStream& MsgStream::operator<< ( std::ostream &(*)(std::ostream &)  _f ) [inline]

Accept oMsgStream modifiers.

Definition at line 131 of file MsgStream.h.

                                                           {
    if ( isActive() ) _f(m_stream);
    return *this;
  }
MsgStream& MsgStream::operator<< ( MsgStream &(*)(MsgStream &)  _f ) [inline]

Accept MsgStream modifiers.

Definition at line 126 of file MsgStream.h.

                                                         {
    if ( isActive() ) _f(*this);
    return *this;
  }
int MsgStream::precision ( int  v ) [inline]

Definition at line 193 of file MsgStream.h.

                       {
    return isActive() ? m_stream.precision(v): 0;
  }
int MsgStream::precision (  ) const [inline]

Definition at line 190 of file MsgStream.h.

                         {
    return isActive() ? m_stream.precision(): 0;
  }
int MsgStream::rdstate (  ) const [inline]

Definition at line 196 of file MsgStream.h.

                       {
    return isActive() ? m_stream.rdstate () : std::ios_base::failbit;
  }
MsgStream& MsgStream::report ( int  lvl ) [inline]

Initialize report of new message: activate if print level is sufficient.

Definition at line 69 of file MsgStream.h.

                               {
    lvl = (lvl >= MSG::NUM_LEVELS) ?
      MSG::ALWAYS : (lvl<MSG::NIL) ? MSG::NIL : lvl;
    ((m_currLevel=MSG::Level(lvl)) >= level()) ? activate() : deactivate();
    return *this;
  }
void MsgStream::resetColor (  )

Reset the colors to defaults.

Definition at line 97 of file MsgStream.cpp.

                           {
#ifndef _WIN32
  if ( m_useColors )   {
    try { // this may throw and we must not do it
      m_stream << "" << m_service->getLogColor(m_currLevel);
    }
    catch(...) {}
  }
#endif
}
void MsgStream::setColor ( MSG::Color  col )

Set the text color.

Definition at line 70 of file MsgStream.cpp.

                                     {
#ifndef _WIN32
  if ( m_useColors)   {
    int fc = 90 + col;
    try { // this may throw and we must not do it
      m_stream << "[" << fc << ";1m";
    }
    catch(...) {}
  }
#endif
}
void MsgStream::setColor ( MSG::Color  fg,
MSG::Color  bg 
)

Set the foreground and background colors.

Definition at line 82 of file MsgStream.cpp.

                                                 {
#ifndef _WIN32
  if ( m_useColors )   {
    try { // this may throw and we must not do it
      int fc = 90 + fg;
      m_stream << "[" << fc;
      int bc = 100 + bg;
      m_stream << ";" << bc;
      m_stream << ";1m";
    }
    catch(...) {}
  }
#endif
}
long MsgStream::setf ( FLAG_TYPE  v ) [inline]

Definition at line 175 of file MsgStream.h.

                         {
    return isActive() ? m_stream.setf(v)  :  0;
  }
long MsgStream::setf ( FLAG_TYPE  _f,
FLAG_TYPE  _m 
) [inline]

Definition at line 208 of file MsgStream.h.

                                        {
    return isActive() ? m_stream.setf(_f, _m)   : 0;
  }
void MsgStream::setLevel ( int  level ) [inline]

Update outputlevel.

Definition at line 90 of file MsgStream.h.

                              {
    level = (level >= MSG::NUM_LEVELS) ?
      MSG::ALWAYS : (level<MSG::NIL) ? MSG::NIL : level;
    m_level = MSG::Level(level);
  }
void MsgStream::setMsgSvc ( IMessageSvc *  svc ) [inline]

Update IMessageSvc pointer.

Definition at line 86 of file MsgStream.h.

                                     {
    m_service = svc;
  }
std::ostringstream& MsgStream::stream (  ) [inline]

Access string MsgStream.

Definition at line 82 of file MsgStream.h.

                               {
    return m_stream;
  }
void MsgStream::unsetf ( FLAG_TYPE  _l ) [inline]

Definition at line 211 of file MsgStream.h.

                               {
    if ( isActive() ) m_stream.unsetf(_l);
  }
int MsgStream::width (  ) const [inline]

Definition at line 178 of file MsgStream.h.

                    {
    return isActive() ? m_stream.width()    : 0;
  }
int MsgStream::width ( int  v ) [inline]

Definition at line 181 of file MsgStream.h.

                   {
    return isActive() ? m_stream.width(v)    : 0;
  }
MsgStream& MsgStream::write ( const char *  buff,
int  len 
) [inline]

Definition at line 121 of file MsgStream.h.

                                              {
    if ( isActive() ) m_stream.write(buff, len);
    return *this;
  }

Member Data Documentation

bool MsgStream::m_active [protected]

Flag set to true if formatting engine is active.

Definition at line 42 of file MsgStream.h.

std::string MsgStream::m_buffer [protected]

Use standard string for information buffering.

Definition at line 36 of file MsgStream.h.

MSG::Level MsgStream::m_currLevel [protected]

Current debug level.

Definition at line 46 of file MsgStream.h.

MSG::Level MsgStream::m_level [protected]

Debug level of the message service.

Definition at line 44 of file MsgStream.h.

IMessageSvc* MsgStream::m_service [protected]

Pointer to message service if buffer has send.

Definition at line 34 of file MsgStream.h.

std::string MsgStream::m_source [protected]

Use std::string for source information to be passed to the message service.

Definition at line 38 of file MsgStream.h.

std::ostringstream MsgStream::m_stream [protected]

String MsgStream associated to buffer.

Definition at line 40 of file MsgStream.h.

bool MsgStream::m_useColors [protected]

use colors

Definition at line 48 of file MsgStream.h.

The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Defines
Generated at Mon Feb 28 2011 18:28:17 for Gaudi Framework, version v22r1 by Doxygen version 1.7.2 written by Dimitri van Heesch, © 1997-2004