ldas-tools-al 2.6.7
Loading...
Searching...
No Matches
LDASTools::AL::Log::StreamInterface Class Referenceabstract

Class to handle streaming of messages. More...

#include <Log.hh>

Inheritance diagram for LDASTools::AL::Log::StreamInterface:
Inheritance graph
[legend]

Public Types

typedef boost::shared_ptr< StreamCBInterface > callback_type
typedef boost::shared_ptr< StreamCBInterface > callback_type

Public Member Functions

 StreamInterface ()
 Constructor.
virtual ~StreamInterface ()
 Destructor.
void Callback (callback_type Callback)
 Establish callback.
virtual void Close ()=0
 How to close the stream.
virtual bool IsOpen () const =0
 Resturn the open state of the stream.
virtual void Open ()=0
 How to open the stream.
virtual void WriteMessage (const std::string &Message)=0
 How to open the stream.
template<typename T>
std::ostream & operator<< (T a)
 Output to the stream.
 StreamInterface ()
 Constructor.
virtual ~StreamInterface ()
 Destructor.
void Callback (callback_type Callback)
 Establish callback.
virtual void Close ()=0
 How to close the stream.
virtual bool IsOpen () const =0
 Resturn the open state of the stream.
virtual void Open ()=0
 How to open the stream.
virtual void WriteMessage (const std::string &Message)=0
 How to open the stream.
template<typename T>
std::ostream & operator<< (T a)
 Output to the stream.

Protected Member Functions

void onClose ()
 Destructor.
void onOpen ()
 Destructor.
virtual std::ostream & stream ()=0
 Gain access to the stream.
void onClose ()
void onOpen ()
virtual std::ostream & stream ()=0
 Gain access to the stream.

Private Attributes

callback_type callback
 Callback storage.

Detailed Description

Class to handle streaming of messages.

This is an pure abstract class which describes the interface that needs to be created by derived classes.

Member Typedef Documentation

◆ callback_type [1/2]

typedef boost::shared_ptr< StreamCBInterface > LDASTools::AL::Log::StreamInterface::callback_type

◆ callback_type [2/2]

typedef boost::shared_ptr< StreamCBInterface > LDASTools::AL::Log::StreamInterface::callback_type

Constructor & Destructor Documentation

◆ StreamInterface() [1/2]

LDASTools::AL::Log::StreamInterface::StreamInterface ( )

Constructor.

◆ ~StreamInterface() [1/2]

LDASTools::AL::Log::StreamInterface::~StreamInterface ( )
virtual

Destructor.

◆ StreamInterface() [2/2]

LDASTools::AL::Log::StreamInterface::StreamInterface ( )

Constructor.

◆ ~StreamInterface() [2/2]

virtual LDASTools::AL::Log::StreamInterface::~StreamInterface ( )
virtual

Destructor.

Member Function Documentation

◆ Callback() [1/2]

void LDASTools::AL::Log::StreamInterface::Callback ( callback_type Callback)
inline

Establish callback.

◆ Callback() [2/2]

void LDASTools::AL::Log::StreamInterface::Callback ( callback_type Callback)

Establish callback.

◆ Close() [1/2]

virtual void LDASTools::AL::Log::StreamInterface::Close ( )
pure virtual

How to close the stream.

Implemented in anonymous_namespace{Log.cc}::Log::StreamFile, anonymous_namespace{Log.cc}::Log::StreamFile, anonymous_namespace{Log.cc}::Log::StreamStdErr, anonymous_namespace{Log.cc}::Log::StreamStdErr, LDASTools::AL::Log::StreamFile, LDASTools::AL::Log::StreamFile, LDASTools::AL::Log::StreamStdErr, and LDASTools::AL::Log::StreamStdErr.

◆ Close() [2/2]

virtual void LDASTools::AL::Log::StreamInterface::Close ( )
pure virtual

How to close the stream.

Implemented in anonymous_namespace{Log.cc}::Log::StreamFile, anonymous_namespace{Log.cc}::Log::StreamFile, anonymous_namespace{Log.cc}::Log::StreamStdErr, anonymous_namespace{Log.cc}::Log::StreamStdErr, LDASTools::AL::Log::StreamFile, LDASTools::AL::Log::StreamFile, LDASTools::AL::Log::StreamStdErr, and LDASTools::AL::Log::StreamStdErr.

◆ IsOpen() [1/2]

virtual bool LDASTools::AL::Log::StreamInterface::IsOpen ( ) const
pure virtual

Resturn the open state of the stream.

Returns
If the stream is open and writable, then return true. Otherwise, false.

Implemented in anonymous_namespace{Log.cc}::Log::StreamFile, anonymous_namespace{Log.cc}::Log::StreamFile, anonymous_namespace{Log.cc}::Log::StreamStdErr, anonymous_namespace{Log.cc}::Log::StreamStdErr, LDASTools::AL::Log::StreamFile, LDASTools::AL::Log::StreamFile, LDASTools::AL::Log::StreamStdErr, and LDASTools::AL::Log::StreamStdErr.

◆ IsOpen() [2/2]

virtual bool LDASTools::AL::Log::StreamInterface::IsOpen ( ) const
pure virtual

Resturn the open state of the stream.

Returns
If the stream is open and writable, then return true. Otherwise, false.

Implemented in anonymous_namespace{Log.cc}::Log::StreamFile, anonymous_namespace{Log.cc}::Log::StreamFile, anonymous_namespace{Log.cc}::Log::StreamStdErr, anonymous_namespace{Log.cc}::Log::StreamStdErr, LDASTools::AL::Log::StreamFile, LDASTools::AL::Log::StreamFile, LDASTools::AL::Log::StreamStdErr, and LDASTools::AL::Log::StreamStdErr.

◆ onClose() [1/2]

void LDASTools::AL::Log::StreamInterface::onClose ( )
protected

Destructor.

◆ onClose() [2/2]

void LDASTools::AL::Log::StreamInterface::onClose ( )
protected

◆ onOpen() [1/2]

void LDASTools::AL::Log::StreamInterface::onOpen ( )
protected

Destructor.

◆ onOpen() [2/2]

void LDASTools::AL::Log::StreamInterface::onOpen ( )
protected

◆ Open() [1/2]

virtual void LDASTools::AL::Log::StreamInterface::Open ( )
pure virtual

How to open the stream.

Implemented in anonymous_namespace{Log.cc}::Log::StreamFile, anonymous_namespace{Log.cc}::Log::StreamFile, anonymous_namespace{Log.cc}::Log::StreamStdErr, anonymous_namespace{Log.cc}::Log::StreamStdErr, LDASTools::AL::Log::StreamFile, LDASTools::AL::Log::StreamFile, LDASTools::AL::Log::StreamStdErr, and LDASTools::AL::Log::StreamStdErr.

◆ Open() [2/2]

virtual void LDASTools::AL::Log::StreamInterface::Open ( )
pure virtual

How to open the stream.

Implemented in anonymous_namespace{Log.cc}::Log::StreamFile, anonymous_namespace{Log.cc}::Log::StreamFile, anonymous_namespace{Log.cc}::Log::StreamStdErr, anonymous_namespace{Log.cc}::Log::StreamStdErr, LDASTools::AL::Log::StreamFile, LDASTools::AL::Log::StreamFile, LDASTools::AL::Log::StreamStdErr, and LDASTools::AL::Log::StreamStdErr.

◆ operator<<() [1/2]

template<typename T>
std::ostream & LDASTools::AL::Log::StreamInterface::operator<< ( T a)
inline

Output to the stream.

◆ operator<<() [2/2]

template<typename T>
std::ostream & LDASTools::AL::Log::StreamInterface::operator<< ( T a)
inline

Output to the stream.

◆ stream() [1/2]

virtual std::ostream & LDASTools::AL::Log::StreamInterface::stream ( )
protectedpure virtual

Gain access to the stream.

Implemented in anonymous_namespace{Log.cc}::Log::StreamFile, anonymous_namespace{Log.cc}::Log::StreamFile, anonymous_namespace{Log.cc}::Log::StreamStdErr, anonymous_namespace{Log.cc}::Log::StreamStdErr, LDASTools::AL::Log::StreamFile, LDASTools::AL::Log::StreamFile, LDASTools::AL::Log::StreamStdErr, and LDASTools::AL::Log::StreamStdErr.

◆ stream() [2/2]

virtual std::ostream & LDASTools::AL::Log::StreamInterface::stream ( )
protectedpure virtual

Gain access to the stream.

Implemented in anonymous_namespace{Log.cc}::Log::StreamFile, anonymous_namespace{Log.cc}::Log::StreamFile, anonymous_namespace{Log.cc}::Log::StreamStdErr, anonymous_namespace{Log.cc}::Log::StreamStdErr, LDASTools::AL::Log::StreamFile, LDASTools::AL::Log::StreamFile, LDASTools::AL::Log::StreamStdErr, and LDASTools::AL::Log::StreamStdErr.

◆ WriteMessage() [1/2]

virtual void LDASTools::AL::Log::StreamInterface::WriteMessage ( const std::string & Message)
pure virtual

How to open the stream.

Parameters
[in]MessageThe message to send to the output stream.

Implemented in anonymous_namespace{Log.cc}::Log::StreamFile, anonymous_namespace{Log.cc}::Log::StreamFile, anonymous_namespace{Log.cc}::Log::StreamStdErr, anonymous_namespace{Log.cc}::Log::StreamStdErr, LDASTools::AL::Log::StreamFile, LDASTools::AL::Log::StreamFile, LDASTools::AL::Log::StreamStdErr, and LDASTools::AL::Log::StreamStdErr.

◆ WriteMessage() [2/2]

virtual void LDASTools::AL::Log::StreamInterface::WriteMessage ( const std::string & Message)
pure virtual

How to open the stream.

Parameters
[in]MessageThe message to send to the output stream.

Implemented in anonymous_namespace{Log.cc}::Log::StreamFile, anonymous_namespace{Log.cc}::Log::StreamFile, anonymous_namespace{Log.cc}::Log::StreamStdErr, anonymous_namespace{Log.cc}::Log::StreamStdErr, LDASTools::AL::Log::StreamFile, LDASTools::AL::Log::StreamFile, LDASTools::AL::Log::StreamStdErr, and LDASTools::AL::Log::StreamStdErr.

Member Data Documentation

◆ callback

callback_type LDASTools::AL::Log::StreamInterface::callback
private

Callback storage.

If this is set, then this instance is called to handle additional actions that should happen when the stream is opened or closed.

The documentation for this class was generated from the following files:
  • /home/abuild/rpmbuild/BUILD/ldas-tools-al-2.6.7-build/ldas-tools-al-2.6.7/build/include/ldastoolsal/Log.hh
  • /home/abuild/rpmbuild/BUILD/ldas-tools-al-2.6.7-build/ldas-tools-al-2.6.7/src/Log.hh
  • /home/abuild/rpmbuild/BUILD/ldas-tools-al-2.6.7-build/ldas-tools-al-2.6.7/src/Log.cc