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
	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
	operator std::string () const
virtual Issue *	receive ()
	Receives an issue from the stream.
Static Public Member Functions
static std::string	to_string (const Issue *issue) throw ()
Static Public Attributes
static const char *const	KEY = "human"
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 27 of file HumanStream.h.

---

Constructor & Destructor Documentation

ers::HumanStream::HumanStream

(

)

Definition at line 47 of file HumanStream.cxx.

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

ers::HumanStream::HumanStream

(

const HumanStream &

other

)

Definition at line 48 of file HumanStream.cxx.

: ers::Stream(other) {} 

ers::HumanStream::~HumanStream

(

)

Definition at line 49 of file HumanStream.cxx.

{} 

---

Member Function Documentation

void ers::HumanStream::clear

(

)

Clears the content of the stream

Definition at line 61 of file HumanStream.cxx.

References m_out_stream.

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

ers::Stream::operator std::string

(

)

const [inherited]

Definition at line 35 of file Stream.cxx.

References ers::Stream::print_to().

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

void ers::HumanStream::print_to

(

std::ostream &

stream

)

const [virtual]

Reimplemented from ers::Stream.

Definition at line 65 of file HumanStream.cxx.

References KEY.

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

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.

Definition at line 55 of file Stream.cxx.

                             {
    return 0 ; 
} // receive

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.

Definition at line 69 of file HumanStream.cxx.

References ers::error, ERS_HERE, ERS_PRE_CHECK_PTR, false, first, ers::Issue::get_value(), ers::Issue::get_value_table(), if(), key, m_out_stream, ers::Issue::MESSAGE_KEY, boss::pos, ers::Issue::SEVERITY_KEY, deljobs::string, and true.

Referenced by to_string().

                                                {
    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

(

)

Returns:

the content of the stream as a string

Definition at line 54 of file HumanStream.cxx.

References m_out_stream.

Referenced by ers::Issue::human_description().

                                    { 
     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

Definition at line 35 of file HumanStream.cxx.

References send(), deljobs::string, and to_string().

Referenced by to_string().

                                                                  {
    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 = "human" [static]

Definition at line 32 of file HumanStream.h.

Referenced by create_stream(), and print_to().

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

Definition at line 29 of file HumanStream.h.

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

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

Key for discard stream

Definition at line 39 of file Stream.h.

Referenced by create_stream(), and ers::Stream::print_to().

---