Main Page | Namespace List | Class Hierarchy | Class List | File List | Namespace Members | Class Members | File Members

RTM::SubscriberBase Class Reference

Subscriber object. This is derived from ACE_Task active object and observer pattern is alos applied. More...

#include <RtcSubscriber.h>

Inheritance diagram for RTM::SubscriberBase:

RTM::SubscriberNew RTM::SubscriberNewPeriodic RTM::SubscriberOnce RTM::SubscriberPeriodic RTM::SubscriberPeriodicNew RTM::SubscriberPeriodicTriggerd RTM::SubscriberTriggerd RTM::SubscriberTriggerdPeriodic List of all members.

Public Member Functions

 SubscriberBase (OutPortBase *parent, InPort_ptr inport, const SubscriptionID id, SubscriberProfile profile)
 ~SubscriberBase ()
 SubscriberBase class destructor.

virtual int open (void *args)
 Start SubscriberBase service.

virtual int svc (void)=0
 Main part of SubscriberBase service (pure virtual method).

virtual bool update ()=0
 Update data to subscribers. (pure virtual method).

virtual void release ()
 Stop subscriber service.

virtual SubscriberProfile get_profile ()
 Get SubscriberProfile.

virtual InPort_ptr get_inport ()
 Get InPort's object reference which subscribe this OutPort.

virtual std::string get_id ()
 Get InPort's object reference which subscribe this OutPort.


Protected Attributes

SubscriberProfile m_Profile
 Request type. once or periodic.

InPort_ptr m_pInPort
 Input port object reference.

OutPortBasem_pParent
 Parent outport object reference.

std::string m_Id
 Subscription ID.

NewData m_NewData

Detailed Description

Subscriber object. This is derived from ACE_Task active object and observer pattern is alos applied.

A base class of Subscriber*. Variation of Subscriber* which implements details of subscriber inherits this SubscriberBase class.


Constructor & Destructor Documentation

RTM::SubscriberBase::SubscriberBase OutPortBase parent,
InPort_ptr  inport,
const SubscriptionID  id,
SubscriberProfile  profile
 

Parameters:
parent OutPort pointer which instansiate Subscriber*.
inport An InPort object reference wihch subscribe parent OutPort.
id SubscriptionID¡£Unique UUID.
profile Profile of this subscription.

RTM::SubscriberBase::~SubscriberBase  ) 
 

SubscriberBase class destructor.


Member Function Documentation

virtual std::string RTM::SubscriberBase::get_id  )  [virtual]
 

Get InPort's object reference which subscribe this OutPort.

virtual InPort_ptr RTM::SubscriberBase::get_inport  )  [virtual]
 

Get InPort's object reference which subscribe this OutPort.

virtual SubscriberProfile RTM::SubscriberBase::get_profile  )  [virtual]
 

Get SubscriberProfile.

virtual int RTM::SubscriberBase::open void *  args  )  [virtual]
 

Start SubscriberBase service.

virtual void RTM::SubscriberBase::release  )  [virtual]
 

Stop subscriber service.

virtual int RTM::SubscriberBase::svc void   )  [pure virtual]
 

Main part of SubscriberBase service (pure virtual method).

Implemented in RTM::SubscriberOnce, RTM::SubscriberPeriodic, RTM::SubscriberNew, RTM::SubscriberTriggerd, RTM::SubscriberPeriodicNew, RTM::SubscriberNewPeriodic, RTM::SubscriberPeriodicTriggerd, and RTM::SubscriberTriggerdPeriodic.

virtual bool RTM::SubscriberBase::update  )  [pure virtual]
 

Update data to subscribers. (pure virtual method).

Implemented in RTM::SubscriberOnce, RTM::SubscriberPeriodic, RTM::SubscriberNew, RTM::SubscriberTriggerd, RTM::SubscriberPeriodicNew, RTM::SubscriberNewPeriodic, RTM::SubscriberPeriodicTriggerd, and RTM::SubscriberTriggerdPeriodic.


Member Data Documentation

std::string RTM::SubscriberBase::m_Id [protected]
 

Subscription ID.

NewData RTM::SubscriberBase::m_NewData [protected]
 

InPort_ptr RTM::SubscriberBase::m_pInPort [protected]
 

Input port object reference.

OutPortBase* RTM::SubscriberBase::m_pParent [protected]
 

Parent outport object reference.

SubscriberProfile RTM::SubscriberBase::m_Profile [protected]
 

Request type. once or periodic.


The documentation for this class was generated from the following file:
Generated on Thu Dec 16 15:29:20 2004 for OpenRTM by doxygen 1.3.6