RTC::PublisherPeriodic Class Reference

PublisherPeriodic class. More...

#include <PublisherPeriodic.h>

Inheritance diagram for RTC::PublisherPeriodic:

RTC::PublisherBase

List of all members.

Public Member Functions

 PublisherPeriodic (InPortConsumer *consumer, const Properties &property)
 Constructor.
virtual ~PublisherPeriodic ()
 Destructor.
virtual void update ()
 Observer function.
virtual int svc (void)
 Thread execution function.
virtual int open (void *args)
 Start task.
virtual void release ()
 Task terminate function.


Detailed Description

PublisherPeriodic class.

Publisher that invokes the consumer's sending process periodically. This is used when the data sending is regularly executed.


Constructor & Destructor Documentation

RTC::PublisherPeriodic::PublisherPeriodic ( InPortConsumer consumer,
const Properties property 
)

Constructor.

Constructor. The intervals of invoking send processing needs to be set in dataport.push_rate of Property object. The interval is specified by floating point string in Hz. For example, "1000.0" is set for 1000.0Hz. If the above property is unset, "1000Hz" will be set.

Parameters:
consumer Consumer which waits for data sending
property Property objects that are set the control information of this Publisher

virtual RTC::PublisherPeriodic::~PublisherPeriodic (  )  [virtual]

Destructor.

Destructor


Member Function Documentation

virtual void RTC::PublisherPeriodic::update (  )  [virtual]

Observer function.

Execute nothing in this Publisher.

Implements RTC::PublisherBase.

virtual int RTC::PublisherPeriodic::svc ( void   )  [virtual]

Thread execution function.

ACE_Task::svc() override function.

virtual int RTC::PublisherPeriodic::open ( void *  args  )  [virtual]

Start task.

ACE_Task::open() override function.

virtual void RTC::PublisherPeriodic::release (  )  [virtual]

Task terminate function.

ACE_Task::release() override function. Set driven flag to false, and terminate the operation of this Publisher. However, the consumer's sending process may be invoked once or less.

Reimplemented from RTC::PublisherBase.


Generated on Thu May 29 15:03:33 2008 for OpenRTM by  doxygen 1.5.3