CCA

Typed output port. More...

#include <OutputPort.h>

Inheritance diagram for cca::OutputPort< DATATYPE >:
Collaboration diagram for cca::OutputPort< DATATYPE >:

List of all members.

Public Types

typedef ::boost::shared_ptr
< DATATYPE > 
DataPtr
 Defines a shared pointer for the data-type of this port.
typedef ::boost::shared_ptr
< OutputPort< DATATYPE > > 
Ptr
 Defines a shared pointer for this typed port.

Public Member Functions

 OutputPort (bool optional=Port::MANDATORY)
 Protected constructor.
virtual ~OutputPort ()
void publish (DataPtr data)
virtual ::std::string print () const
 Printing information about this OutputPort.
virtual void configureSpecifics ()
 Output port-specific configuration, sets up informer.

Static Public Member Functions

static Ptr create ()
 Creator.

Protected Member Functions

 OutputPort (OutputPort &port)
 Copy constructor Copy constructor private for now to disallow copying.
void operator= (const OutputPort &port)
 Copy operator Copy operator private for now to disallow copying.

Protected Attributes

typename::rsb::Informer
< DATATYPE >::Ptr 
informer

Detailed Description

template<class DATATYPE>
class cca::OutputPort< DATATYPE >

Typed output port.

Definition at line 58 of file OutputPort.h.


Member Typedef Documentation

template<class DATATYPE>
typedef ::boost::shared_ptr<DATATYPE> cca::OutputPort< DATATYPE >::DataPtr

Defines a shared pointer for the data-type of this port.

Definition at line 63 of file OutputPort.h.

template<class DATATYPE>
typedef ::boost::shared_ptr<OutputPort<DATATYPE> > cca::OutputPort< DATATYPE >::Ptr

Defines a shared pointer for this typed port.

Definition at line 66 of file OutputPort.h.


Constructor & Destructor Documentation

template<class DATATYPE>
cca::OutputPort< DATATYPE >::OutputPort ( bool  optional = Port::MANDATORY) [inline]

Protected constructor.

Todo:
Better handling of exception, when rsb transOutputPort for the selected OutputPort type is not avaiable.

Definition at line 74 of file OutputPort.h.

template<class DATATYPE>
virtual cca::OutputPort< DATATYPE >::~OutputPort ( ) [inline, virtual]
Returns:

Definition at line 82 of file OutputPort.h.

template<class DATATYPE>
cca::OutputPort< DATATYPE >::OutputPort ( OutputPort< DATATYPE > &  port) [protected]

Copy constructor Copy constructor private for now to disallow copying.


Member Function Documentation

template<class DATATYPE>
virtual void cca::OutputPort< DATATYPE >::configureSpecifics ( ) [inline, virtual]

Output port-specific configuration, sets up informer.

Implements cca::Port.

Definition at line 133 of file OutputPort.h.

template<class DATATYPE>
static Ptr cca::OutputPort< DATATYPE >::create ( ) [inline, static]

Creator.

Returns:
Shared pointer to new output port

Definition at line 108 of file OutputPort.h.

template<class DATATYPE>
void cca::OutputPort< DATATYPE >::operator= ( const OutputPort< DATATYPE > &  port) [protected]

Copy operator Copy operator private for now to disallow copying.

template<class DATATYPE>
virtual ::std::string cca::OutputPort< DATATYPE >::print ( ) const [inline, virtual]

Printing information about this OutputPort.

Implements cca::Port.

Definition at line 115 of file OutputPort.h.

Referenced by cca::timing::BeatProvider::beat(), and cca::ComponentInfo::displayStatePorts().

Here is the caller graph for this function:

template<class DATATYPE>
void cca::OutputPort< DATATYPE >::publish ( DataPtr  data) [inline]

Definition at line 85 of file OutputPort.h.

Referenced by cca::timing::BeatProvider::beat(), cca::timing::HeartBeat::execute(), cca::Collector< DTOTYPE >::onProcess(), and cca::Component::publishState().

Here is the caller graph for this function:


Member Data Documentation

template<class DATATYPE>
typename ::rsb::Informer<DATATYPE>::Ptr cca::OutputPort< DATATYPE >::informer [protected]

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