ers::HumanStream Class Reference

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

#include <HumanStream.h>

Inheritance diagram for ers::HumanStream:

List of all members.

Public Member Functions
void	clear ()
void	clear ()
	HumanStream (const HumanStream &other)
	HumanStream ()
	HumanStream (const HumanStream &other)
	HumanStream ()
	operator std::string () const
	operator std::string () const
virtual void	print_to (std::ostream &stream) const
virtual void	print_to (std::ostream &stream) const
virtual Issue *	receive ()
	Receives an issue from the stream.
virtual Issue *	receive ()
	Receives an issue from the stream.
virtual void	send (const Issue *ptr)
	Sends an issue into the stream.
virtual void	send (const Issue *ptr)
	Sends an issue into the stream.
std::string	to_string ()
std::string	to_string ()
	~HumanStream ()
	~HumanStream ()
Static Public Member Functions
std::string	to_string (const Issue *issue) throw ()
std::string	to_string (const Issue *issue) throw ()
Static Public Attributes
const char *const	KEY
const char *const	KEY = "human"
const char *const	NULL_STREAM_KEY
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

---

Constructor & Destructor Documentation

ers::HumanStream::HumanStream (   )

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

ers::HumanStream::HumanStream (  const HumanStream &  other  )

: ers::Stream(other) {}

ers::HumanStream::~HumanStream (   )

{}

ers::HumanStream::HumanStream (   )

ers::HumanStream::HumanStream (  const HumanStream &  other  )

ers::HumanStream::~HumanStream (   )

---

Member Function Documentation

void ers::HumanStream::clear (   )

void ers::HumanStream::clear (   )

Clears the content of the stream { m_out_stream.str(""); } // clear

ers::Stream::operator std::string (   )  const [inherited]

ers::Stream::operator std::string (   )  const [inherited]

{ std::ostringstream stream ; print_to(stream); return stream.str(); } // to string

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

Reimplemented from ers::Stream.

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

Reimplemented from ers::Stream. { stream << ers::HumanStream::KEY << ':' ; } // print_to

virtual Issue* ers::Stream::receive (   )  [virtual, inherited]

Receives an issue from the stream. Reimplemented in ers::FIFOStream, and ers::FIFOStream.

ers::Issue * ers::Stream::receive (   )  [virtual, inherited]

Receives an issue from the stream. Reads an isssue on the stream Returns: the issue that has been read Note: This implementation always returns a null pointer Reimplemented in ers::FIFOStream, and ers::FIFOStream. { return 0 ; } // receive

virtual void ers::HumanStream::send (  const Issue *  ptr  )  [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.

void ers::HumanStream::send (  const Issue *  issue_ptr  )  [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. { 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

std::string ers::HumanStream::to_string (   )

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

std::string ers::HumanStream::to_string (   )

Returns: the content of the stream as a string { return m_out_stream.str(); } // to_string

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 { 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

---

Member Data Documentation

const char* const ers::HumanStream::KEY [static]

const char *const ers::HumanStream::KEY = "human" [static]

std::ostringstream ers::HumanStream::m_out_stream [protected]

const char* const ers::Stream::NULL_STREAM_KEY [static, inherited]

Key for discard stream

const char *const ers::Stream::NULL_STREAM_KEY = "null" [static, inherited]

Key for discard stream

---

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

• /data0/mdestefa/bes3soft/Boss_6.5.5/dist/6.5.5/Event/ers/ers-00-00-01/ers/HumanStream.h
• /data0/mdestefa/bes3soft/Boss_6.5.5/dist/6.5.5/InstallArea/include/ers/ers/HumanStream.h
• /data0/mdestefa/bes3soft/Boss_6.5.5/dist/6.5.5/Event/ers/ers-00-00-01/src/HumanStream.cxx

---