TwiceAsNice  2019-02-18
Public Types | Public Member Functions | Private Types | List of all members
Basda::RingbufferDevice< DataType > Class Template Referenceabstract


Generic Class for a Device More...

#include <RingbufferDevice.h>

Inheritance diagram for Basda::RingbufferDevice< DataType >:
Inheritance graph
Collaboration diagram for Basda::RingbufferDevice< DataType >:
Collaboration graph

Public Types

typedef Ringbuffer< DataType > DataRingbufferType
 
typedef IceUtil::Handle< DataRingbufferTypeDataRingbufferTypePtr
 
typedef Ringbuffer< DataType > DataRingbufferType
 
typedef IceUtil::Handle< DataRingbufferTypeDataRingbufferTypePtr
 

Public Member Functions

virtual DataRingbufferTypePtr ringbuffer ()=0
 
 RingbufferDevice (const Nice::JointPtr &_config)
 
 ~RingbufferDevice ()
 
virtual bool isIdle ()
 
virtual RingbufferRegime::State state ()
 
DataTypePtr lastData ()
 
size_t lastDataNum ()
 
void waitForState (RingbufferRegime::State _state, DeviceAsync &_async=s_async)
 
bool timedWaitForState (RingbufferRegime::State _state, const Nice::Time &_time, DeviceAsync &_async=s_async)
 
RingbufferRegime::State waitForStateChange (DeviceAsync &_async=s_async)
 
RingbufferRegime::State timedWaitForStateChange (const Nice::Time &_time, DeviceAsync &_async=s_async)
 
RingbufferRegime::State waitForNextData (DataTypePtr &_img, int _last, DeviceAsync &_async=s_async)
 
RingbufferRegime::State timedWaitForNextData (DataTypePtr &_img, int _last, const Nice::Time &_time, DeviceAsync &_async=s_async)
 
RingbufferRegime::State waitForNewData (DataTypePtr &_img, DeviceAsync &_async=s_async)
 
RingbufferRegime::State timedWaitForNewData (DataTypePtr &_img, const Nice::Time &_time, DeviceAsync &_async=s_async)
 
virtual DataRingbufferTypePtr ringbuffer ()=0
 
 RingbufferDevice (const Nice::JointPtr &_config)
 
 ~RingbufferDevice ()
 
virtual bool isIdle ()
 
virtual RingbufferRegime::State state ()
 
DataTypePtr lastData ()
 
size_t lastDataNum ()
 
void waitForState (RingbufferRegime::State _state, DeviceAsync &_async=s_async)
 
bool timedWaitForState (RingbufferRegime::State _state, const Nice::Time &_time, DeviceAsync &_async=s_async)
 
RingbufferRegime::State waitForStateChange (DeviceAsync &_async=s_async)
 
RingbufferRegime::State timedWaitForStateChange (const Nice::Time &_time, DeviceAsync &_async=s_async)
 
RingbufferRegime::State waitForNextData (DataTypePtr &_img, int _last, DeviceAsync &_async=s_async)
 
RingbufferRegime::State timedWaitForNextData (DataTypePtr &_img, int _last, const Nice::Time &_time, DeviceAsync &_async=s_async)
 
RingbufferRegime::State waitForNewData (DataTypePtr &_img, DeviceAsync &_async=s_async)
 
RingbufferRegime::State timedWaitForNewData (DataTypePtr &_img, const Nice::Time &_time, DeviceAsync &_async=s_async)
 
- Public Member Functions inherited from Basda::Device
 Device (const Nice::JointPtr &_config)
 constructor. This is an elementary (lazy) action which stores the name and gets configuration. More...
 
virtual ~Device ()
 destructor Does nothing More...
 
virtual void setConfig (const Nice::JointPtr &_config)
 init with config tree ptr More...
 
Nice::JointPtrconfig ()
 retrieve the property tree More...
 
std::string & name ()
 retrieve the name set at ctor time. More...
 
virtual void open ()=0
 open device More...
 
virtual void close ()=0
 close device More...
 
virtual void reset (DeviceAsync &=s_async)=0
 reset the device More...
 
virtual void version ()=0
 version More...
 
virtual void init (DeviceAsync &=s_async)=0
 init the device More...
 
virtual void deinit (DeviceAsync &=s_async)=0
 deinit the device More...
 
virtual void activate (DeviceAsync &=s_async)=0
 activate the device More...
 
virtual void deactivate (DeviceAsync &=s_async)=0
 deactivate the device More...
 
 Device (const Nice::JointPtr &_config)
 constructor. This is an elementary (lazy) action which stores the name and gets configuration. More...
 
virtual ~Device ()
 destructor Does nothing More...
 
virtual void setConfig (const Nice::JointPtr &_config)
 init with config tree ptr More...
 
Nice::JointPtrconfig ()
 retrieve the property tree More...
 
std::string & name ()
 retrieve the name set at ctor time. More...
 
virtual void open ()=0
 open device More...
 
virtual void close ()=0
 close device More...
 
virtual void reset (DeviceAsync &=s_async)=0
 reset the device More...
 
virtual void version ()=0
 version More...
 
virtual void init (DeviceAsync &=s_async)=0
 init the device More...
 
virtual void deinit (DeviceAsync &=s_async)=0
 deinit the device More...
 
virtual void activate (DeviceAsync &=s_async)=0
 activate the device More...
 
virtual void deactivate (DeviceAsync &=s_async)=0
 deactivate the device More...
 

Private Types

typedef IceUtil::Handle< DataType > DataTypePtr
 
typedef IceUtil::Handle< DataType > DataTypePtr
 

Additional Inherited Members

- Static Public Attributes inherited from Basda::Device
static DeviceAsyncImpl s_async
 
- Protected Attributes inherited from Basda::Device
Nice::JointPtr m_config
 
Nice::JointPtr m_cfg
 
Nice::JointPtr m_var
 
std::string m_name
 

Detailed Description

template<typename DataType>
class Basda::RingbufferDevice< DataType >


Generic Class for a Device

Author
Florian Briegel
Version
09.01.26
Date
2009-07-03 11:58:06 AM
Todo:
Author
Florian Briegel
Version
09.01.26
Date
2009-07-03 11:58:06 AM
Todo:

Member Typedef Documentation

◆ DataRingbufferType [1/2]

template<typename DataType>
typedef Ringbuffer<DataType> Basda::RingbufferDevice< DataType >::DataRingbufferType

◆ DataRingbufferType [2/2]

template<typename DataType>
typedef Ringbuffer<DataType> Basda::RingbufferDevice< DataType >::DataRingbufferType

◆ DataRingbufferTypePtr [1/2]

template<typename DataType>
typedef IceUtil::Handle<DataRingbufferType> Basda::RingbufferDevice< DataType >::DataRingbufferTypePtr

◆ DataRingbufferTypePtr [2/2]

template<typename DataType>
typedef IceUtil::Handle<DataRingbufferType> Basda::RingbufferDevice< DataType >::DataRingbufferTypePtr

◆ DataTypePtr [1/2]

template<typename DataType>
typedef IceUtil::Handle<DataType> Basda::RingbufferDevice< DataType >::DataTypePtr
private

◆ DataTypePtr [2/2]

template<typename DataType>
typedef IceUtil::Handle<DataType> Basda::RingbufferDevice< DataType >::DataTypePtr
private

Constructor & Destructor Documentation

◆ RingbufferDevice() [1/2]

template<typename DataType>
Basda::RingbufferDevice< DataType >::RingbufferDevice ( const Nice::JointPtr _config)
inline

◆ ~RingbufferDevice() [1/2]

template<typename DataType>
Basda::RingbufferDevice< DataType >::~RingbufferDevice ( )
inline

◆ RingbufferDevice() [2/2]

template<typename DataType>
Basda::RingbufferDevice< DataType >::RingbufferDevice ( const Nice::JointPtr _config)
inline

◆ ~RingbufferDevice() [2/2]

template<typename DataType>
Basda::RingbufferDevice< DataType >::~RingbufferDevice ( )
inline

Member Function Documentation

◆ isIdle() [1/2]

template<typename DataType>
virtual bool Basda::RingbufferDevice< DataType >::isIdle ( )
inlinevirtual

◆ isIdle() [2/2]

template<typename DataType>
virtual bool Basda::RingbufferDevice< DataType >::isIdle ( )
inlinevirtual

◆ lastData() [1/2]

template<typename DataType>
DataTypePtr Basda::RingbufferDevice< DataType >::lastData ( )
inline

◆ lastData() [2/2]

template<typename DataType>
DataTypePtr Basda::RingbufferDevice< DataType >::lastData ( )
inline

◆ lastDataNum() [1/2]

template<typename DataType>
size_t Basda::RingbufferDevice< DataType >::lastDataNum ( )
inline

◆ lastDataNum() [2/2]

template<typename DataType>
size_t Basda::RingbufferDevice< DataType >::lastDataNum ( )
inline

◆ ringbuffer() [1/2]

template<typename DataType>
virtual DataRingbufferTypePtr Basda::RingbufferDevice< DataType >::ringbuffer ( )
pure virtual

◆ ringbuffer() [2/2]

template<typename DataType>
virtual DataRingbufferTypePtr Basda::RingbufferDevice< DataType >::ringbuffer ( )
pure virtual

◆ state() [1/2]

template<typename DataType>
virtual RingbufferRegime::State Basda::RingbufferDevice< DataType >::state ( )
inlinevirtual

◆ state() [2/2]

template<typename DataType>
virtual RingbufferRegime::State Basda::RingbufferDevice< DataType >::state ( )
inlinevirtual

◆ timedWaitForNewData() [1/2]

template<typename DataType>
RingbufferRegime::State Basda::RingbufferDevice< DataType >::timedWaitForNewData ( DataTypePtr _img,
const Nice::Time _time,
DeviceAsync _async = s_async 
)
inline

◆ timedWaitForNewData() [2/2]

template<typename DataType>
RingbufferRegime::State Basda::RingbufferDevice< DataType >::timedWaitForNewData ( DataTypePtr _img,
const Nice::Time _time,
DeviceAsync _async = s_async 
)
inline

◆ timedWaitForNextData() [1/2]

template<typename DataType>
RingbufferRegime::State Basda::RingbufferDevice< DataType >::timedWaitForNextData ( DataTypePtr _img,
int  _last,
const Nice::Time _time,
DeviceAsync _async = s_async 
)
inline

◆ timedWaitForNextData() [2/2]

template<typename DataType>
RingbufferRegime::State Basda::RingbufferDevice< DataType >::timedWaitForNextData ( DataTypePtr _img,
int  _last,
const Nice::Time _time,
DeviceAsync _async = s_async 
)
inline

◆ timedWaitForState() [1/2]

template<typename DataType>
bool Basda::RingbufferDevice< DataType >::timedWaitForState ( RingbufferRegime::State  _state,
const Nice::Time _time,
DeviceAsync _async = s_async 
)
inline

◆ timedWaitForState() [2/2]

template<typename DataType>
bool Basda::RingbufferDevice< DataType >::timedWaitForState ( RingbufferRegime::State  _state,
const Nice::Time _time,
DeviceAsync _async = s_async 
)
inline

◆ timedWaitForStateChange() [1/2]

template<typename DataType>
RingbufferRegime::State Basda::RingbufferDevice< DataType >::timedWaitForStateChange ( const Nice::Time _time,
DeviceAsync _async = s_async 
)
inline

◆ timedWaitForStateChange() [2/2]

template<typename DataType>
RingbufferRegime::State Basda::RingbufferDevice< DataType >::timedWaitForStateChange ( const Nice::Time _time,
DeviceAsync _async = s_async 
)
inline

◆ waitForNewData() [1/2]

template<typename DataType>
RingbufferRegime::State Basda::RingbufferDevice< DataType >::waitForNewData ( DataTypePtr _img,
DeviceAsync _async = s_async 
)
inline

◆ waitForNewData() [2/2]

template<typename DataType>
RingbufferRegime::State Basda::RingbufferDevice< DataType >::waitForNewData ( DataTypePtr _img,
DeviceAsync _async = s_async 
)
inline

◆ waitForNextData() [1/2]

template<typename DataType>
RingbufferRegime::State Basda::RingbufferDevice< DataType >::waitForNextData ( DataTypePtr _img,
int  _last,
DeviceAsync _async = s_async 
)
inline

◆ waitForNextData() [2/2]

template<typename DataType>
RingbufferRegime::State Basda::RingbufferDevice< DataType >::waitForNextData ( DataTypePtr _img,
int  _last,
DeviceAsync _async = s_async 
)
inline

◆ waitForState() [1/2]

template<typename DataType>
void Basda::RingbufferDevice< DataType >::waitForState ( RingbufferRegime::State  _state,
DeviceAsync _async = s_async 
)
inline

◆ waitForState() [2/2]

template<typename DataType>
void Basda::RingbufferDevice< DataType >::waitForState ( RingbufferRegime::State  _state,
DeviceAsync _async = s_async 
)
inline

◆ waitForStateChange() [1/2]

template<typename DataType>
RingbufferRegime::State Basda::RingbufferDevice< DataType >::waitForStateChange ( DeviceAsync _async = s_async)
inline

◆ waitForStateChange() [2/2]

template<typename DataType>
RingbufferRegime::State Basda::RingbufferDevice< DataType >::waitForStateChange ( DeviceAsync _async = s_async)
inline

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