OrocosComponentLibrary  2.6.0
Public Member Functions
CategoryStream Class Reference

This is a utility class which you can use to stream messages into a category object. More...

#include <CategoryStream.hpp>

List of all members.

Public Member Functions

 CategoryStream (Category *rt_category, log4cpp::Priority::Value priority)
 Construct a CategoryStream for given Category with given priority.
 CategoryStream (const CategoryStream &rhs)
 Copy-constructor needed because the output string stream can't be copied.
virtual ~CategoryStream ()
 Destructor for CategoryStream which also flushes any remaining data to the Category object.
void flush ()
 Flush the contents of the stream buffer to the Category and empties the buffer.
template<typename T >
CategoryStreamoperator<< (const T &t)
 Stream in arbitrary types and objects.

Detailed Description

This is a utility class which you can use to stream messages into a category object.

It provides an std::iostream like syntax using the << operator, but you need to call flush() in order to do the actual write of your message.

Definition at line 19 of file CategoryStream.hpp.


Constructor & Destructor Documentation

CategoryStream ( Category rt_category,
log4cpp::Priority::Value  priority 
)

Construct a CategoryStream for given Category with given priority.

Parameters:
categoryThe category this stream will send log messages to.
priorityThe priority the log messages will get or Priority::NOTSET to silently discard any streamed in messages.

Definition at line 7 of file CategoryStream.cpp.

CategoryStream ( const CategoryStream rhs)

Copy-constructor needed because the output string stream can't be copied.

We rater have to copy the underlying (real-time) string.

Parameters:
rhsThe CategoryStream to copy from

Definition at line 32 of file CategoryStream.cpp.


Member Function Documentation

CategoryStream& operator<< ( const T &  t) [inline]

Stream in arbitrary types and objects.

Parameters:
tThe value or object to stream in.
Returns:
A reference to itself.

Definition at line 55 of file CategoryStream.hpp.


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