orcaqguielementutil::PtrIceStormElement< PainterType, DataType, DataPtrType, ProxyType, ConsumerType, ConsumerPrxType > Class Template Reference

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

#include <ptricestormelement.h>

List of all members.

Public Member Functions
	PtrIceStormElement (const orcaice::Context &context, const std::string &proxyString, PainterType &painter, const double timeoutMs=5000.0)
virtual void	actionOnConnection ()=0
	Can do special stuff on connection by inheriting and overloading this.
void	updateFromBuffer ()
Protected Attributes
orcaqguielementutil::PtrIceStormListener < DataType, DataPtrType, ProxyType, ConsumerType, ConsumerPrxType >	listener_
	Object to handle network communication, including subscription process.
PainterType &	painter_
	Object to handle painting to our data to screen.

---

Detailed Description

template<class PainterType, class DataType, class DataPtrType, class ProxyType, class ConsumerType, class ConsumerPrxType>
class orcaqguielementutil::PtrIceStormElement< PainterType, DataType, DataPtrType, ProxyType, ConsumerType, ConsumerPrxType >

Base class for gui elements that receive data from IceStorm.

Connects to an interface, passes info to painter

Author:

Alex Brooks

---

Constructor & Destructor Documentation

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

orcaqguielementutil::PtrIceStormElement< PainterType, DataType, DataPtrType, ProxyType, ConsumerType, ConsumerPrxType >::PtrIceStormElement	(	const orcaice::Context &	context,
		const std::string &	proxyString,
		PainterType &	painter,
		const double	timeoutMs = 5000.0
	)			[inline]

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

---

Member Function Documentation

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

void orcaqguielementutil::PtrIceStormElement< PainterType, DataType, DataPtrType, ProxyType, ConsumerType, ConsumerPrxType >::updateFromBuffer

(

)

[inline]

From GuiElement2d: Here we pop data from the consumer buffer, and give it to the painter.

References orcaqguielementutil::PtrIceStormElement< PainterType, DataType, DataPtrType, ProxyType, ConsumerType, ConsumerPrxType >::listener_, and orcaqguielementutil::PtrIceStormElement< PainterType, DataType, DataPtrType, ProxyType, ConsumerType, ConsumerPrxType >::painter_.

---

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

• ptricestormelement.h