orcaqguielementutil::IceStormElement< DataType, ProxyType, ConsumerType, ConsumerPrxType > Class Template Reference

Base class for gui elements that receive data from IceStorm. More...

#include <icestormelement.h>

Inherited by orcaqguielementutil::IceStormGuiElement2d< DriveBicyclePainter, orca::DriveBicycleData, orca::DriveBicyclePrx, orca::DriveBicycleConsumer, orca::DriveBicycleConsumerPrx >, orcaqguielementutil::IceStormGuiElement2d< FeatureMap2dPainter, orca::FeatureMap2dData, orca::FeatureMap2dPrx, orca::FeatureMap2dConsumer, orca::FeatureMap2dConsumerPrx >, orcaqguielementutil::IceStormGuiElement2d< LaserScanner2dPainter, orca::RangeScanner2dDataPtr, orca::LaserScanner2dPrx, orca::RangeScanner2dConsumer, orca::RangeScanner2dConsumerPrx >, orcaqguielementutil::IceStormGuiElement2d< LaserScanner2dPainter, orca::RangeScanner2dDataPtr, orca::RangeScanner2dPrx, orca::RangeScanner2dConsumer, orca::RangeScanner2dConsumerPrx >, orcaqguielementutil::IceStormGuiElement2d< Localise2dPainter, orca::Localise2dData, orca::Localise2dPrx, orca::Localise2dConsumer, orca::Localise2dConsumerPrx >, orcaqguielementutil::IceStormGuiElement2d< Localise3dPainter, orca::Localise3dData, orca::Localise3dPrx, orca::Localise3dConsumer, orca::Localise3dConsumerPrx >, orcaqguielementutil::IceStormGuiElement2d< Odometry2dPainter, orca::Odometry2dData, orca::Odometry2dPrx, orca::Odometry2dConsumer, orca::Odometry2dConsumerPrx >, orcaqguielementutil::IceStormGuiElement2d< OgMapPainter, orca::OgMapData, orca::OgMapPrx, orca::OgMapConsumer, orca::OgMapConsumerPrx >, orcaqguielementutil::IceStormGuiElement2d< Particle2dPainter, orca::Particle2dData, orca::Particle2dPrx, orca::Particle2dConsumer, orca::Particle2dConsumerPrx >, orcaqguielementutil::IceStormGuiElement2d< PathPlannerPainter, orca::PathPlanner2dData, orca::PathPlanner2dPrx, orca::PathPlanner2dConsumer, orca::PathPlanner2dConsumerPrx >, orcaqguielementutil::IceStormGuiElement2d< PixMapBackgroundPainter, orca::PixMapData, orca::PixMapPrx, orca::PixMapConsumer, orca::PixMapConsumerPrx >, orcaqguielementutil::IceStormGuiElement2d< PolarFeature2dPainter, orca::PolarFeature2dData, orca::PolarFeature2dPrx, orca::PolarFeature2dConsumer, orca::PolarFeature2dConsumerPrx >, orcaqguielementutil::IceStormGuiElement2d< QGraphics2dPainter, orca::QGraphics2dData, orca::QGraphics2dPrx, orca::QGraphics2dConsumer, orca::QGraphics2dConsumerPrx >, orcaqguielementutil::IceStormGuiElement2d< RangerArrayPainter, orca::RangerArrayDataPtr, orca::RangerArrayPrx, orca::RangerArrayConsumer, orca::RangerArrayConsumerPrx >, orcaqguielementutil::IceStormGuiElement< orca::WifiData, orca::WifiPrx, orca::WifiConsumer, orca::WifiConsumerPrx >, orcaqgui3d::IceStormElement3d< PainterType, DataType, ProxyType, ConsumerType, ConsumerPrxType >, orcaqguielementutil::IceStormGuiElement< DataType, ProxyType, ConsumerType, ConsumerPrxType >, and orcaqguielementutil::IceStormGuiElement2d< PainterType, DataType, ProxyType, ConsumerType, ConsumerPrxType >.

List of all members.

Public Member Functions
	IceStormElement (const orcaice::Context &context, const std::string &proxyString, const double timeoutMs, const double tryConnectIntervalSec=2.5)
virtual void	iceStormConnectedEvent ()
	Can do special stuff on connection by inheriting and overloading this.
Protected Member Functions
bool	updateFromStore ()
	Here we pop data from the consumer store.
Protected Attributes
orcaqguielementutil::IceStormListener < DataType, ProxyType, ConsumerType, ConsumerPrxType >	listener_
	Object to handle network communication, including subscription process.
gbxiceutilacfr::Timer	tryConnectTimer_
	Controls the frequency with which we try to connect.

---

Detailed Description

template<class DataType, class ProxyType, class ConsumerType, class ConsumerPrxType>
class orcaqguielementutil::IceStormElement< DataType, ProxyType, ConsumerType, ConsumerPrxType >

Base class for gui elements that receive data from IceStorm.

Connects to an interface

Author:

Alex Brooks, Tobias Kaupp

---

Constructor & Destructor Documentation

template<class DataType, class ProxyType, class ConsumerType, class ConsumerPrxType>

orcaqguielementutil::IceStormElement< DataType, ProxyType, ConsumerType, ConsumerPrxType >::IceStormElement	(	const orcaice::Context &	context,
		const std::string &	proxyString,
		const double	timeoutMs,
		const double	tryConnectIntervalSec = 2.5
	)			[inline]

timeoutMs is how long we wait before assuming a problem and trying to reconnect. (timoutMs = -1 means we never timeout)

---

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

• icestormelement.h