User Manual, Developers Guide and API Documentation

glue::Stamper< COMMAND > Class Template Reference

This FU stamps all outgoing compounds with a pre-set command.

#include <Stamper.hpp>

Inheritance diagram for glue::Stamper< COMMAND >:

Inheritance graph
[legend]
Collaboration diagram for glue::Stamper< COMMAND >:

Collaboration graph
[legend]

List of all members.

Public Types

typedef COMMAND Command

Public Member Functions

const CommandgetStamp () const
 Return the stamp.
virtual void processIncoming (const wns::ldk::CompoundPtr &)
 Process compounds on uplink.
virtual void processOutgoing (const wns::ldk::CompoundPtr &compound)
 Process compounds on downlink.
void setStamp (const Command &stamp)
 Set the stamp.
 Stamper (wns::ldk::fun::FUN *fun, wns::pyconfig::View &config)
virtual ~Stamper ()

Private Attributes

wns::logger::Logger logger
std::string logMessage
Commandstamp


Detailed Description

template<class COMMAND>
class glue::Stamper< COMMAND >

Definition at line 35 of file Stamper.hpp.


Member Typedef Documentation

template<class COMMAND>
typedef COMMAND glue::Stamper< COMMAND >::Command

Definition at line 44 of file Stamper.hpp.


Constructor & Destructor Documentation

template<class COMMAND>
glue::Stamper< COMMAND >::Stamper ( wns::ldk::fun::FUN fun,
wns::pyconfig::View config 
) [inline]

Definition at line 46 of file Stamper.hpp.

template<class COMMAND>
virtual glue::Stamper< COMMAND >::~Stamper (  )  [inline, virtual]

Definition at line 61 of file Stamper.hpp.


Member Function Documentation

template<class COMMAND>
const Command& glue::Stamper< COMMAND >::getStamp (  )  const [inline]

Definition at line 104 of file Stamper.hpp.

template<class COMMAND>
virtual void glue::Stamper< COMMAND >::processIncoming ( const wns::ldk::CompoundPtr compound  )  [inline, virtual]

Override this method to handle incoming compounds.

Implements wns::ldk::ProcessorInterface.

Definition at line 68 of file Stamper.hpp.

template<class COMMAND>
virtual void glue::Stamper< COMMAND >::processOutgoing ( const wns::ldk::CompoundPtr  )  [inline, virtual]

Override this method to handle outgoing compounds.

Implements wns::ldk::ProcessorInterface.

Definition at line 73 of file Stamper.hpp.

template<class COMMAND>
void glue::Stamper< COMMAND >::setStamp ( const Command stamp  )  [inline]

After calling this method, all outgoing compounds will get stamped with the given command as it was by the time this method was called.

Definition at line 94 of file Stamper.hpp.


Member Data Documentation

template<class COMMAND>
wns::logger::Logger glue::Stamper< COMMAND >::logger [private]

Definition at line 111 of file Stamper.hpp.

template<class COMMAND>
std::string glue::Stamper< COMMAND >::logMessage [private]

Definition at line 112 of file Stamper.hpp.

template<class COMMAND>
Command* glue::Stamper< COMMAND >::stamp [private]

Definition at line 110 of file Stamper.hpp.


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

Generated on Sat May 26 03:32:30 2012 for openWNS by  doxygen 1.5.5