Public Member Functions | Private Member Functions | Private Attributes | List of all members
PublisherPeriodic::MockConsumer Class Reference
Inheritance diagram for PublisherPeriodic::MockConsumer:
Inheritance graph
[legend]

Public Member Functions

virtual RTC::InPortConsumerclone () const
 
virtual int getCount () const
 
virtual const std::vector< long > & getIntervalTicks () const
 
virtual void init (coil::Properties &prop)
 Initializing configuration. More...
 
 MockConsumer ()
 
virtual void publishInterfaceProfile (SDOPackage::NVList &properties)
 Publish InterfaceProfile information. More...
 
virtual void push ()
 
virtual InPortConsumer::ReturnCode put (const cdrMemoryStream &data)
 Send data to the destination port. More...
 
virtual bool subscribeInterface (const SDOPackage::NVList &)
 Subscribe the data send notification. More...
 
virtual void unsubscribeInterface (const SDOPackage::NVList &)
 Unsubscribe the data send notification. More...
 
virtual ~MockConsumer ()
 
- Public Member Functions inherited from RTC::InPortConsumer
virtual DATAPORTSTATUS_ENUM ~InPortConsumer (void)
 Destructor. More...
 

Private Member Functions

void clearLastTime ()
 
bool isLastTimeCleared ()
 

Private Attributes

std::vector< long > _intervalTicks
 
timeval _lastTime
 

Additional Inherited Members

- Public Types inherited from RTC::DataPortStatus
enum  Enum {
  PORT_OK = 0, PORT_ERROR, BUFFER_ERROR, BUFFER_FULL,
  BUFFER_EMPTY, BUFFER_TIMEOUT, SEND_FULL, SEND_TIMEOUT,
  RECV_EMPTY, RECV_TIMEOUT, INVALID_ARGS, PRECONDITION_NOT_MET,
  CONNECTION_LOST, UNKNOWN_ERROR
}
 DataPortStatus return codes. More...
 
- Static Public Member Functions inherited from RTC::DataPortStatus
static const char * toString (DataPortStatus::Enum status)
 Convert DataPortStatus into the string. More...
 

Detailed Description

Definition at line 227 of file PublisherPeriodicTests.cpp.

Constructor & Destructor Documentation

◆ MockConsumer()

PublisherPeriodic::MockConsumer::MockConsumer ( )
inline

Definition at line 231 of file PublisherPeriodicTests.cpp.

◆ ~MockConsumer()

virtual PublisherPeriodic::MockConsumer::~MockConsumer ( )
inlinevirtual

Definition at line 236 of file PublisherPeriodicTests.cpp.

Member Function Documentation

◆ clearLastTime()

void PublisherPeriodic::MockConsumer::clearLastTime ( )
inlineprivate

Definition at line 301 of file PublisherPeriodicTests.cpp.

◆ clone()

virtual RTC::InPortConsumer* PublisherPeriodic::MockConsumer::clone ( ) const
inlinevirtual

Definition at line 255 of file PublisherPeriodicTests.cpp.

◆ getCount()

virtual int PublisherPeriodic::MockConsumer::getCount ( ) const
inlinevirtual

Definition at line 279 of file PublisherPeriodicTests.cpp.

◆ getIntervalTicks()

virtual const std::vector<long>& PublisherPeriodic::MockConsumer::getIntervalTicks ( ) const
inlinevirtual

Definition at line 274 of file PublisherPeriodicTests.cpp.

◆ init()

virtual void PublisherPeriodic::MockConsumer::init ( coil::Properties prop)
inlinevirtual

Initializing configuration.

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

Implements RTC::InPortConsumer.

Definition at line 284 of file PublisherPeriodicTests.cpp.

◆ isLastTimeCleared()

bool PublisherPeriodic::MockConsumer::isLastTimeCleared ( )
inlineprivate

Definition at line 307 of file PublisherPeriodicTests.cpp.

◆ publishInterfaceProfile()

virtual void PublisherPeriodic::MockConsumer::publishInterfaceProfile ( SDOPackage::NVList &  properties)
inlinevirtual

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 291 of file PublisherPeriodicTests.cpp.

◆ push()

virtual void PublisherPeriodic::MockConsumer::push ( )
inlinevirtual

Definition at line 238 of file PublisherPeriodicTests.cpp.

◆ put()

virtual InPortConsumer::ReturnCode PublisherPeriodic::MockConsumer::put ( const cdrMemoryStream &  data)
inlinevirtual

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 287 of file PublisherPeriodicTests.cpp.

◆ subscribeInterface()

virtual bool PublisherPeriodic::MockConsumer::subscribeInterface ( const SDOPackage::NVList &  properties)
inlinevirtual

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 264 of file PublisherPeriodicTests.cpp.

◆ unsubscribeInterface()

virtual void PublisherPeriodic::MockConsumer::unsubscribeInterface ( const SDOPackage::NVList &  properties)
inlinevirtual

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 269 of file PublisherPeriodicTests.cpp.

Member Data Documentation

◆ _intervalTicks

std::vector<long> PublisherPeriodic::MockConsumer::_intervalTicks
private

Definition at line 296 of file PublisherPeriodicTests.cpp.

◆ _lastTime

timeval PublisherPeriodic::MockConsumer::_lastTime
private

Definition at line 297 of file PublisherPeriodicTests.cpp.


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


openrtm_aist
Author(s): Noriaki Ando
autogenerated on Mon Feb 28 2022 23:00:47