orca-robotics


INTRODUCTION
Overview
Download and Install
Quick Start
Documentation
Publications

REPOSITORY
Interfaces
Components
Libraries
Utilities
Software Map

DEVELOPER
Tutorials
Examples
Dev Guide
Dashboard
Wiki
login/pass: orca/orca

PEOPLE
Contributors
Users

SourceForge.net Logo
Project
Download
Mailing lists

 

         

orcaifaceimpl::ConsumerImpl< ProviderPrxType, ConsumerType, ConsumerPrxType, ObjectType > Class Template Reference

#include <consumerImpl.h>

Inherits orcaifaceimpl::ConsumerSubscriber.

Inherited by orcaifaceimpl::BufferedConsumerImpl< ProviderPrxType, ConsumerType, ConsumerPrxType, ObjectType >, orcaifaceimpl::NotifyingConsumerImpl< ProviderPrxType, ConsumerType, ConsumerPrxType, ObjectType >, orcaifaceimpl::PrintingConsumerImpl< ProviderPrxType, ConsumerType, ConsumerPrxType, ObjectType >, and orcaifaceimpl::StoringConsumerImpl< ProviderPrxType, ConsumerType, ConsumerPrxType, ObjectType >.

Inheritance diagram for orcaifaceimpl::ConsumerImpl< ProviderPrxType, ConsumerType, ConsumerPrxType, ObjectType >:

Inheritance graph
[legend]
List of all members.

Public Member Functions

 ConsumerImpl (const orcaice::Context &context)
 Constructor.
virtual void subscribeWithString (const std::string &proxyString)
virtual void subscribeWithTag (const std::string &interfaceTag)
 Same as subscribeWithString() but the interface is looked up using the config file and tag interfaceTag.
virtual void unsubscribeWithString (const std::string &proxyString)
virtual void unsubscribeWithTag (const std::string &interfaceTag)
 Same as unsubscribeWithString() but the interface is looked up using the config file and tag interfaceTag.
virtual void subscribeWithString (const std::string &proxyString, gbxsickacfr::gbxiceutilacfr::Thread *thread, const std::string &subsysName="", int retryInterval=2, int retryNumber=-1)
virtual void subscribeWithTag (const std::string &interfaceTag, gbxsickacfr::gbxiceutilacfr::Thread *thread, const std::string &subsysName="", int retryInterval=2, int retryNumber=-1)
ConsumerPrxType consumerPrx () const
 Access to the proxy to the internal consumer interface implementation.

Protected Member Functions

virtual void handleData (const ObjectType &data)=0
 Implement this call back in the derived class.

Protected Attributes

orcaice::Context context_
 Component context.

Detailed Description

template<class ProviderPrxType, class ConsumerType, class ConsumerPrxType, class ObjectType>
class orcaifaceimpl::ConsumerImpl< ProviderPrxType, ConsumerType, ConsumerPrxType, ObjectType >

A generic consumer: instantiates and looks after a consumerI, i.e. adds it to/removes it from the adapter.

Derived classes need to implement the handleData() callback.


Member Function Documentation

template<class ProviderPrxType, class ConsumerType, class ConsumerPrxType, class ObjectType>
virtual void orcaifaceimpl::ConsumerImpl< ProviderPrxType, ConsumerType, ConsumerPrxType, ObjectType >::subscribeWithString const std::string &  proxyString,
gbxsickacfr::gbxiceutilacfr::Thread *  thread,
const std::string &  subsysName = "",
int  retryInterval = 2,
int  retryNumber = -1
[inline, virtual]
 

Tries to connect to remote interface with stringified proxy proxyString. Will try to connect retryNumber number of times (-1 means infinite), waiting for retryInterval [s] after each attempt. If succesful, tries to subscribe for data using the internal consumer interface. Catches appropriate exceptions. DOCUMENT!

Implements orcaifaceimpl::ConsumerSubscriber.

template<class ProviderPrxType, class ConsumerType, class ConsumerPrxType, class ObjectType>
virtual void orcaifaceimpl::ConsumerImpl< ProviderPrxType, ConsumerType, ConsumerPrxType, ObjectType >::subscribeWithString const std::string &  proxyString  )  [inline, virtual]
 

Tries to connect to remote interface with stringified proxy proxyString. If succesful, tries to subscribe for data using the internal consumer interface. Does not catch any exceptions.

Implements orcaifaceimpl::ConsumerSubscriber.

template<class ProviderPrxType, class ConsumerType, class ConsumerPrxType, class ObjectType>
virtual void orcaifaceimpl::ConsumerImpl< ProviderPrxType, ConsumerType, ConsumerPrxType, ObjectType >::subscribeWithTag const std::string &  interfaceTag,
gbxsickacfr::gbxiceutilacfr::Thread *  thread,
const std::string &  subsysName = "",
int  retryInterval = 2,
int  retryNumber = -1
[inline, virtual]
 

Same as the threaded version of subscribeWithString() but the interface is looked up using the config file and tag interfaceTag.

Implements orcaifaceimpl::ConsumerSubscriber.

template<class ProviderPrxType, class ConsumerType, class ConsumerPrxType, class ObjectType>
virtual void orcaifaceimpl::ConsumerImpl< ProviderPrxType, ConsumerType, ConsumerPrxType, ObjectType >::unsubscribeWithString const std::string &  proxyString  )  [inline, virtual]
 

Tries to connect to remote interface with stringified proxy proxyString. If succesful, tries to unsubscribe the internal consumer interface. Does not catch any exceptions.

Implements orcaifaceimpl::ConsumerSubscriber.


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

Webmaster: Tobias Kaupp (tobasco at users.sourceforge.net)


Generated for Orca Robotics by  doxygen 1.4.5