Public Member Functions | Private Attributes
PublisherPeriodic::CounterConsumer Class Reference
Inheritance diagram for PublisherPeriodic::CounterConsumer:
Inheritance graph
[legend]

List of all members.

Public Member Functions

virtual RTC::InPortConsumerclone () const
 CounterConsumer (CounterConsumer *component=NULL)
virtual int getCount () const
virtual void init (coil::Properties &prop)
 Initializing configuration.
virtual void publishInterfaceProfile (SDOPackage::NVList &properties)
 Publish InterfaceProfile information.
virtual void push ()
virtual InPortConsumer::ReturnCode put (const cdrMemoryStream &data)
 Send data to the destination port.
virtual bool subscribeInterface (const SDOPackage::NVList &)
 Subscribe the data send notification.
virtual void unsubscribeInterface (const SDOPackage::NVList &)
 Unsubscribe the data send notification.
virtual ~CounterConsumer ()

Private Attributes

CounterConsumer_component
int _count

Detailed Description

Definition at line 313 of file PublisherPeriodicTests.cpp.


Constructor & Destructor Documentation

Definition at line 317 of file PublisherPeriodicTests.cpp.

Definition at line 320 of file PublisherPeriodicTests.cpp.


Member Function Documentation

virtual RTC::InPortConsumer* PublisherPeriodic::CounterConsumer::clone ( ) const [inline, virtual]

Definition at line 332 of file PublisherPeriodicTests.cpp.

virtual int PublisherPeriodic::CounterConsumer::getCount ( ) const [inline, virtual]

Definition at line 350 of file PublisherPeriodicTests.cpp.

virtual void PublisherPeriodic::CounterConsumer::init ( coil::Properties prop) [inline, virtual]

Initializing configuration.

This operation would be called to configure this consumer in initialization.

Implements RTC::InPortConsumer.

Definition at line 355 of file PublisherPeriodicTests.cpp.

virtual void PublisherPeriodic::CounterConsumer::publishInterfaceProfile ( SDOPackage::NVList &  properties) [inline, virtual]

Publish InterfaceProfile information.

Publish interfaceProfile information. Check the dataport.interface_type value of the NameValue object specified by an argument in property information and get information only when the interface type of the specified port is matched.

Parameters:
propertiesProperties to get InterfaceProfile information

Implements RTC::InPortConsumer.

Definition at line 362 of file PublisherPeriodicTests.cpp.

virtual void PublisherPeriodic::CounterConsumer::push ( ) [inline, virtual]

Definition at line 322 of file PublisherPeriodicTests.cpp.

virtual InPortConsumer::ReturnCode PublisherPeriodic::CounterConsumer::put ( const cdrMemoryStream &  data) [inline, virtual]

Send data to the destination port.

Pure virtual function to send data to the destination port.

This function might the following return codes

  • PORT_OK: Normal return
  • PORT_ERROR: Error occurred in data transfer process
  • SEND_FULL: Buffer full although OutPort tried to send data
  • SEND_TIMEOUT: Timeout although OutPort tried to send data
  • CONNECTION_LOST: Connection lost
  • UNKNOWN_ERROR: Unknown error

Implements RTC::InPortConsumer.

Definition at line 358 of file PublisherPeriodicTests.cpp.

virtual bool PublisherPeriodic::CounterConsumer::subscribeInterface ( const SDOPackage::NVList &  properties) [inline, virtual]

Subscribe the data send notification.

Pure virtual function to subscribe the data send notification based on specified property information.

Parameters:
propertiesProperties for reference when subscribing
Returns:
Subscription result

Implements RTC::InPortConsumer.

Definition at line 340 of file PublisherPeriodicTests.cpp.

virtual void PublisherPeriodic::CounterConsumer::unsubscribeInterface ( const SDOPackage::NVList &  properties) [inline, virtual]

Unsubscribe the data send notification.

Pure virtual function to unsubscribe the data send notification.

Parameters:
propertiesProperties for reference when unsubscribing

Implements RTC::InPortConsumer.

Definition at line 345 of file PublisherPeriodicTests.cpp.


Member Data Documentation

Definition at line 368 of file PublisherPeriodicTests.cpp.

Definition at line 367 of file PublisherPeriodicTests.cpp.


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


openrtm_aist
Author(s): Noriaki Ando
autogenerated on Thu Aug 27 2015 14:16:41