orcaifaceimpl::ConsumerSubscriber Class Reference

#include <consumerImpl.h>

Inherited by orcaifaceimpl::ConsumerImpl< orca::DriveBicycle, orca::DriveBicycleConsumer, orca::DriveBicycleData >, orcaifaceimpl::ConsumerImpl< orca::Gps, orca::GpsConsumer, orca::GpsData >, orcaifaceimpl::ConsumerImpl< orca::Image, orca::ImageConsumer, orca::ImageDataPtr >, orcaifaceimpl::ConsumerImpl< orca::Localise2d, orca::Localise2dConsumer, orca::Localise2dData >, orcaifaceimpl::ConsumerImpl< orca::Localise3d, orca::Localise3dConsumer, orca::Localise3dData >, orcaifaceimpl::ConsumerImpl< orca::MultiCamera, orca::MultiCameraConsumer, orca::MultiCameraDataPtr >, orcaifaceimpl::ConsumerImpl< orca::Odometry2d, orca::Odometry2dConsumer, orca::Odometry2dData >, orcaifaceimpl::ConsumerImpl< orca::Odometry3d, orca::Odometry3dConsumer, orca::Odometry3dData >, orcaifaceimpl::ConsumerImpl< orca::PathFollower2d, orca::PathFollower2dConsumer, orca::PathFollower2dData, orcaifaceimpl::PathFollower2dConsumerTypeI >, orcaifaceimpl::ConsumerImpl< orca::RangeScanner2d, orca::RangeScanner2dConsumer, orca::RangeScanner2dDataPtr >, orcaifaceimpl::ConsumerImpl< orca::Status, orca::StatusConsumer, orca::StatusData >, orcaifaceimpl::ConsumerImpl< ProviderType, ConsumerType, ObjectType >, and orcaifaceimpl::ConsumerImpl< ProviderType, ConsumerType, ObjectType, ConsumerTypeIType >.

List of all members.

Public Member Functions
virtual void	subscribeWithString (const std::string &proxyString)=0
void	subscribeWithTag (const std::string &interfaceTag)
	Same as subscribeWithString() but the interface is looked up using the config file and tag interfaceTag.
virtual void	unsubscribe ()=0
virtual bool	subscribeWithString (const std::string &proxyString, gbxutilacfr::Stoppable *activity, const std::string &subsysName="", int retryIntervalSec=2, int retryNumber=-1)=0
bool	subscribeWithTag (const std::string &interfaceTag, gbxutilacfr::Stoppable *activity, const std::string &subsysName="", int retryIntervalSec=2, int retryNumber=-1)
bool	hasBeenSubscribed ()
	Returns TRUE is we have ever been successfully subscribed.
Protected Attributes
orcaice::Context	context_
	Component context.

---

Detailed Description

Functionality which end users needs to know about when telling the ConsumerImpl class class to subscribe to data provider. Because this class is not templated it is possible to have a generic pointer to ConsumerImpl regardless of template parameters.

---

Member Function Documentation

virtual bool orcaifaceimpl::ConsumerSubscriber::subscribeWithString	(	const std::string &	proxyString,
		gbxutilacfr::Stoppable *	activity,
		const std::string &	subsysName = "",
		int	retryIntervalSec = 2,
		int	retryNumber = -1
	)			[pure virtual]

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

Returns TRUE if subscribed succesfully, FALSE otherwise.

Implemented in orcaifaceimpl::ConsumerImpl< ProviderType, ConsumerType, ObjectType, ConsumerTypeIType >, orcaifaceimpl::ConsumerImpl< orca::Odometry3d, orca::Odometry3dConsumer, orca::Odometry3dData >, orcaifaceimpl::ConsumerImpl< orca::DriveBicycle, orca::DriveBicycleConsumer, orca::DriveBicycleData >, orcaifaceimpl::ConsumerImpl< orca::Localise2d, orca::Localise2dConsumer, orca::Localise2dData >, orcaifaceimpl::ConsumerImpl< orca::MultiCamera, orca::MultiCameraConsumer, orca::MultiCameraDataPtr >, orcaifaceimpl::ConsumerImpl< orca::PathFollower2d, orca::PathFollower2dConsumer, orca::PathFollower2dData, orcaifaceimpl::PathFollower2dConsumerTypeI >, orcaifaceimpl::ConsumerImpl< ProviderType, ConsumerType, ObjectType >, orcaifaceimpl::ConsumerImpl< orca::Status, orca::StatusConsumer, orca::StatusData >, orcaifaceimpl::ConsumerImpl< orca::Image, orca::ImageConsumer, orca::ImageDataPtr >, orcaifaceimpl::ConsumerImpl< orca::Gps, orca::GpsConsumer, orca::GpsData >, orcaifaceimpl::ConsumerImpl< orca::Odometry2d, orca::Odometry2dConsumer, orca::Odometry2dData >, orcaifaceimpl::ConsumerImpl< orca::Localise3d, orca::Localise3dConsumer, orca::Localise3dData >, and orcaifaceimpl::ConsumerImpl< orca::RangeScanner2d, orca::RangeScanner2dConsumer, orca::RangeScanner2dDataPtr >.

virtual void orcaifaceimpl::ConsumerSubscriber::subscribeWithString

(

const std::string &

proxyString

)

[pure 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.

Implemented in orcaifaceimpl::ConsumerImpl< ProviderType, ConsumerType, ObjectType, ConsumerTypeIType >, orcaifaceimpl::ConsumerImpl< orca::Odometry3d, orca::Odometry3dConsumer, orca::Odometry3dData >, orcaifaceimpl::ConsumerImpl< orca::DriveBicycle, orca::DriveBicycleConsumer, orca::DriveBicycleData >, orcaifaceimpl::ConsumerImpl< orca::Localise2d, orca::Localise2dConsumer, orca::Localise2dData >, orcaifaceimpl::ConsumerImpl< orca::MultiCamera, orca::MultiCameraConsumer, orca::MultiCameraDataPtr >, orcaifaceimpl::ConsumerImpl< orca::PathFollower2d, orca::PathFollower2dConsumer, orca::PathFollower2dData, orcaifaceimpl::PathFollower2dConsumerTypeI >, orcaifaceimpl::ConsumerImpl< ProviderType, ConsumerType, ObjectType >, orcaifaceimpl::ConsumerImpl< orca::Status, orca::StatusConsumer, orca::StatusData >, orcaifaceimpl::ConsumerImpl< orca::Image, orca::ImageConsumer, orca::ImageDataPtr >, orcaifaceimpl::ConsumerImpl< orca::Gps, orca::GpsConsumer, orca::GpsData >, orcaifaceimpl::ConsumerImpl< orca::Odometry2d, orca::Odometry2dConsumer, orca::Odometry2dData >, orcaifaceimpl::ConsumerImpl< orca::Localise3d, orca::Localise3dConsumer, orca::Localise3dData >, and orcaifaceimpl::ConsumerImpl< orca::RangeScanner2d, orca::RangeScanner2dConsumer, orca::RangeScanner2dDataPtr >.

Referenced by subscribeWithTag().

bool ConsumerSubscriber::subscribeWithTag	(	const std::string &	interfaceTag,
		gbxutilacfr::Stoppable *	activity,
		const std::string &	subsysName = "",
		int	retryIntervalSec = 2,
		int	retryNumber = -1
	)

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

Returns TRUE if subscribed succesfully, FALSE otherwise.

References context_, orcaice::getRequiredInterfaceAsString(), and subscribeWithString().

virtual void orcaifaceimpl::ConsumerSubscriber::unsubscribe

(

)

[pure virtual]

When previously subscribed, tries to connect to the internally-stored topic proxy and unsubscribes. When not currently subscribed, quietly returns.

Implemented in orcaifaceimpl::ConsumerImpl< ProviderType, ConsumerType, ObjectType, ConsumerTypeIType >, orcaifaceimpl::ConsumerImpl< orca::Odometry3d, orca::Odometry3dConsumer, orca::Odometry3dData >, orcaifaceimpl::ConsumerImpl< orca::DriveBicycle, orca::DriveBicycleConsumer, orca::DriveBicycleData >, orcaifaceimpl::ConsumerImpl< orca::Localise2d, orca::Localise2dConsumer, orca::Localise2dData >, orcaifaceimpl::ConsumerImpl< orca::MultiCamera, orca::MultiCameraConsumer, orca::MultiCameraDataPtr >, orcaifaceimpl::ConsumerImpl< orca::PathFollower2d, orca::PathFollower2dConsumer, orca::PathFollower2dData, orcaifaceimpl::PathFollower2dConsumerTypeI >, orcaifaceimpl::ConsumerImpl< ProviderType, ConsumerType, ObjectType >, orcaifaceimpl::ConsumerImpl< orca::Status, orca::StatusConsumer, orca::StatusData >, orcaifaceimpl::ConsumerImpl< orca::Image, orca::ImageConsumer, orca::ImageDataPtr >, orcaifaceimpl::ConsumerImpl< orca::Gps, orca::GpsConsumer, orca::GpsData >, orcaifaceimpl::ConsumerImpl< orca::Odometry2d, orca::Odometry2dConsumer, orca::Odometry2dData >, orcaifaceimpl::ConsumerImpl< orca::Localise3d, orca::Localise3dConsumer, orca::Localise3dData >, and orcaifaceimpl::ConsumerImpl< orca::RangeScanner2d, orca::RangeScanner2dConsumer, orca::RangeScanner2dDataPtr >.

---

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

• consumerImpl.h
• consumerImpl.cpp