ers::HumanStream Class Reference

Single line, human readable format stream. More...

#include <HumanStream.h>

Inheritance diagram for ers::HumanStream:

Public Member Functions
	HumanStream ()
	HumanStream (const HumanStream &other)
	~HumanStream ()
std::string	to_string ()
void	clear ()
virtual void	send (const Issue *ptr)
	Sends an issue into the stream.
virtual void	print_to (std::ostream &stream) const
	HumanStream ()
	HumanStream (const HumanStream &other)
	~HumanStream ()
std::string	to_string ()
void	clear ()
virtual void	send (const Issue *ptr)
	Sends an issue into the stream.
virtual void	print_to (std::ostream &stream) const
	HumanStream ()
	HumanStream (const HumanStream &other)
	~HumanStream ()
std::string	to_string ()
void	clear ()
virtual void	send (const Issue *ptr)
	Sends an issue into the stream.
virtual void	print_to (std::ostream &stream) const
Public Member Functions inherited from ers::Stream
	Stream ()
	Stream (const Stream &other)
	operator std::string () const
virtual	~Stream ()
virtual Issue *	receive ()
	Receives an issue from the stream.
	Stream ()
	Stream (const Stream &other)
	operator std::string () const
virtual	~Stream ()
virtual Issue *	receive ()
	Receives an issue from the stream.
	Stream ()
	Stream (const Stream &other)
	operator std::string () const
virtual	~Stream ()
virtual Issue *	receive ()
	Receives an issue from the stream.

Static Public Member Functions
static std::string	to_string (const Issue *issue) throw ()
static std::string	to_string (const Issue *issue) throw ()
static std::string	to_string (const Issue *issue) throw ()

Static Public Attributes
static const char *const	KEY = "human"
Static Public Attributes inherited from ers::Stream
static const char *const	NULL_STREAM_KEY = "null"

Protected Attributes
std::ostringstream	m_out_stream

Detailed Description

Single line, human readable format stream.

This class streams an issue into an human readable string. It is uses by the issue class to display itself. This stream can be specified for other uses, but the user is then responsible for reading data from the stream and clearing it.

Author

Matthias Wiesmann

Version

1.0

Definition at line 26 of file Event/ers/include/ers/HumanStream.h.

Constructor & Destructor Documentation

HumanStream() [1/6]

ers::HumanStream::HumanStream

(

)

Definition at line 46 of file HumanStream.cxx.

: ers::Stream() {} // HumanStream

Referenced by HumanStream(), and to_string().

HumanStream() [2/6]

ers::HumanStream::HumanStream

(

const HumanStream &

other

)

Definition at line 47 of file HumanStream.cxx.

: ers::Stream( other ) {}

~HumanStream() [1/3]

ers::HumanStream::~HumanStream

(

)

Definition at line 48 of file HumanStream.cxx.

{}

HumanStream() [3/6]

ers::HumanStream::HumanStream

(

)

HumanStream() [4/6]

ers::HumanStream::HumanStream

(

const HumanStream &

other

)

~HumanStream() [2/3]

ers::HumanStream::~HumanStream

(

)

HumanStream() [5/6]

ers::HumanStream::HumanStream

(

)

HumanStream() [6/6]

ers::HumanStream::HumanStream

(

const HumanStream &

other

)

~HumanStream() [3/3]

ers::HumanStream::~HumanStream

(

)

Member Function Documentation

clear() [1/3]

void ers::HumanStream::clear

(

)

Clears the content of the stream

Definition at line 58 of file HumanStream.cxx.

{ m_out_stream.str( "" ); } // clear

clear() [2/3]

void ers::HumanStream::clear

(

)

clear() [3/3]

void ers::HumanStream::clear

(

)

print_to() [1/3]

void ers::HumanStream::print_to ( std::ostream & stream ) const

virtual

Reimplemented from ers::Stream.

Definition at line 60 of file HumanStream.cxx.

                                                        {
  stream << ers::HumanStream::KEY << ':';
} // print_to

print_to() [2/3]

virtual void ers::HumanStream::print_to ( std::ostream & stream ) const

virtual

Reimplemented from ers::Stream.

print_to() [3/3]

virtual void ers::HumanStream::print_to ( std::ostream & stream ) const

virtual

Reimplemented from ers::Stream.

send() [1/3]

void ers::HumanStream::send ( const Issue * i )

virtual

Sends an issue into the stream.

Sends the issue to the stream.

Parameters

i	the issue to send

Note

This implementation silently discards the Issue

Reimplemented from ers::Stream.

Definition at line 64 of file HumanStream.cxx.

                                                  {
  ERS_PRE_CHECK_PTR( issue_ptr );
  if ( m_out_stream )
  {
    try
    {
      const string_map_type* table        = issue_ptr->get_value_table();
      const std::string      message_str  = issue_ptr->get_value( Issue::MESSAGE_KEY );
      const std::string      severity_str = issue_ptr->get_value( Issue::SEVERITY_KEY );
      m_out_stream << "issue: " << message_str << "(" << severity_str << ")[";
      bool first = true;
      for ( string_map_type::const_iterator pos = table->begin(); pos != table->end(); ++pos )
      {
        const std::string& key   = pos->first;
        const std::string& value = pos->second;
        if ( first ) { first = false; }
        else { m_out_stream << ", "; } // first or not
        m_out_stream << key << "=\"" << value << '\"';
      } // for
      m_out_stream << "]";
    } catch ( std::ios_base::failure& ex )
    { throw ers::Issue( ERS_HERE, ers::error, &ex ); } // catch generic I/O errors
  }                                                    // if m_out_stream
} // send

Referenced by to_string().

send() [2/3]

virtual void ers::HumanStream::send ( const Issue * i )

virtual

Sends an issue into the stream.

Sends the issue to the stream.

Parameters

i	the issue to send

Note

This implementation silently discards the Issue

Reimplemented from ers::Stream.

send() [3/3]

virtual void ers::HumanStream::send ( const Issue * i )

virtual

Sends an issue into the stream.

Sends the issue to the stream.

Parameters

i	the issue to send

Note

This implementation silently discards the Issue

Reimplemented from ers::Stream.

to_string() [1/6]

std::string ers::HumanStream::to_string

(

)

Returns

the content of the stream as a string

Definition at line 53 of file HumanStream.cxx.

{ return m_out_stream.str(); } // to_string

to_string() [2/6]

std::string ers::HumanStream::to_string

(

)

to_string() [3/6]

std::string ers::HumanStream::to_string

(

)

to_string() [4/6]

std::string ers::HumanStream::to_string ( const Issue * issue_ptr ) throw (  )

static

Dumps the content of an issue into a string This class is used internally by the Issue class to produce then description field.

Parameters

issue_ptr

the Issue to serialise

Returns

string description

Definition at line 32 of file HumanStream.cxx.

                                                                    {
  try
  {
    HumanStream ers_stream;
    ers_stream.send( issue_ptr );
    std::string str = ers_stream.to_string();
    return str;
  } catch ( std::exception& ex )
  {
    std::string msg = "error while building message " + std::string( ex.what() );
    return msg;
  } //
} // to_string

Referenced by to_string().

to_string() [5/6]

std::string ers::HumanStream::to_string ( const Issue * issue ) throw (  )

static

to_string() [6/6]

std::string ers::HumanStream::to_string ( const Issue * issue ) throw (  )

static

Member Data Documentation

KEY

const char *const ers::HumanStream::KEY = "human"

static

Definition at line 32 of file Event/ers/include/ers/HumanStream.h.

Referenced by print_to(), and to_string().

m_out_stream

std::ostringstream ers::HumanStream::m_out_stream

protected

Definition at line 28 of file Event/ers/include/ers/HumanStream.h.

Referenced by clear(), send(), and to_string().

---

The documentation for this class was generated from the following files:

• Event/ers/include/ers/HumanStream.h
• InstallArea/x86_64-el9-gcc13-dbg/include/ers/HumanStream.h
• InstallArea/x86_64-el9-gcc13-opt/include/ers/HumanStream.h
• HumanStream.cxx