CPN::IQueue< T > Class Template Reference

Template class to do type conversion for reader end of the queue. More...

#include <IQueue.h>

Collaboration diagram for CPN::IQueue< T >:

Public Member Functions
	IQueue ()
	IQueue (shared_ptr< QueueReader > q)
const T *	GetDequeuePtr (unsigned thresh, unsigned chan=0)
void	Dequeue (unsigned count)
bool	Dequeue (T *data, unsigned count)
bool	Dequeue (T *data, unsigned count, unsigned numChans, unsigned chanStride)
void	Reset ()
bool	Flushed ()
unsigned	NumChannels () const
unsigned	MaxThreshold () const
unsigned	QueueLength () const
unsigned	Count () const
bool	Empty () const
unsigned	ChannelStride () const
Key_t	GetKey () const
shared_ptr< QueueReader >	GetReader ()
void	Release ()
	Release this reader all further actions are invalid. More...

Private Attributes
shared_ptr< QueueReader >	queue

Detailed Description

template<class T>
class CPN::IQueue< T >

Template class to do type conversion for reader end of the queue.

Definition at line 39 of file IQueue.h.

Constructor & Destructor Documentation

template<class T >

CPN::IQueue< T >::IQueue ( )

inline

Definition at line 41 of file IQueue.h.

{}

template<class T >

CPN::IQueue< T >::IQueue ( shared_ptr< QueueReader >  q )

inline

Definition at line 42 of file IQueue.h.

References CPN::IQueue< T >::queue, and CPN::TypeCompatable().

                                          : queue(q) {
            if (!TypeCompatable(TypeName<T>(), queue->GetDatatype())) {
                throw TypeMismatchException(TypeName<T>(), queue->GetDatatype());
            }
        }

Here is the call graph for this function:

Member Function Documentation

template<class T >

unsigned CPN::IQueue< T >::ChannelStride ( ) const

inline

Returns

the current channel stride, only call this right after a successful call to GetDequeuePtr.

Definition at line 103 of file IQueue.h.

References CPN::IQueue< T >::queue.

{ return queue->ChannelStride()/GetTypeSize<T>(); }

template<class T >

unsigned CPN::IQueue< T >::Count ( ) const

inline

Returns

the number of data elements in the channel

Definition at line 99 of file IQueue.h.

References CPN::IQueue< T >::queue.

{ return queue->Count()/GetTypeSize<T>(); }

template<class T >

void CPN::IQueue< T >::Dequeue ( unsigned  count )

inline

Dispose of count elements from the queue.

Parameters

count

the number to dispose of

Definition at line 63 of file IQueue.h.

References CPN::IQueue< T >::queue.

                                     {
            queue->Dequeue(GetTypeSize<T>() * count);
        }

template<class T >

bool CPN::IQueue< T >::Dequeue ( T *  data, unsigned  count  )

inline

Read count element into the array data.

Parameters

data	the array
count	the number of elements

Returns

true on success, false if the endpoint has shutdown

Definition at line 73 of file IQueue.h.

References CPN::IQueue< T >::queue.

                                              {
            return queue->RawDequeue((void*)data, GetTypeSize<T>() * count);
        }

template<class T >

bool CPN::IQueue< T >::Dequeue ( T *  data, unsigned  count, unsigned  numChans, unsigned  chanStride  )

inline

Read count element into the 2D array data with the given number of channels and channel stride.

Parameters

data	the array
count	the number of elements in each channel
numChans	the number of channels
chanStride	the number of elements between each channel

Definition at line 85 of file IQueue.h.

References CPN::IQueue< T >::queue.

                                                                                      {
            return queue->RawDequeue((void*)data, GetTypeSize<T>() * count,
                    numChans, GetTypeSize<T>() * chanStride);
        }

template<class T >

bool CPN::IQueue< T >::Empty ( ) const

inline

Returns

true if empty, false otherwise

Definition at line 101 of file IQueue.h.

References CPN::IQueue< T >::queue.

{ return queue->Empty(); }

template<class T >

bool CPN::IQueue< T >::Flushed ( )

inline

Definition at line 91 of file IQueue.h.

References CPN::IQueue< T >::queue.

{ return queue->Flushed(); }

template<class T >

const T* CPN::IQueue< T >::GetDequeuePtr ( unsigned  thresh, unsigned  chan = 0  )

inline

Get an array of the given type of the given length from the given channel to read from.

Parameters

thresh	the size of the returned array.
chan	the channel

Returns

the array

Definition at line 55 of file IQueue.h.

References CPN::IQueue< T >::queue.

                                                                 {
            return (T*) queue->GetRawDequeuePtr(GetTypeSize<T>() * thresh, chan);
        }

template<class T >

Key_t CPN::IQueue< T >::GetKey ( ) const

inline

Returns

the endpoint key

Definition at line 105 of file IQueue.h.

References CPN::IQueue< T >::queue.

{ return queue->GetKey(); }

template<class T >

shared_ptr<QueueReader> CPN::IQueue< T >::GetReader ( )

inline

Returns

the underlying reader

Definition at line 107 of file IQueue.h.

References CPN::IQueue< T >::queue.

{ return queue; }

template<class T >

unsigned CPN::IQueue< T >::MaxThreshold ( ) const

inline

Returns

the maximum threshold in data elements

Definition at line 96 of file IQueue.h.

References CPN::IQueue< T >::queue.

{ return queue->MaxThreshold()/GetTypeSize<T>(); }

template<class T >

unsigned CPN::IQueue< T >::NumChannels ( ) const

inline

Returns

the number of channels

Definition at line 94 of file IQueue.h.

References CPN::IQueue< T >::queue.

{ return queue->NumChannels(); }

template<class T >

unsigned CPN::IQueue< T >::QueueLength ( ) const

inline

Definition at line 97 of file IQueue.h.

References CPN::IQueue< T >::queue.

{ return queue->QueueLength()/GetTypeSize<T>(); }

template<class T >

void CPN::IQueue< T >::Release ( )

inline

Release this reader all further actions are invalid.

Definition at line 109 of file IQueue.h.

References CPN::IQueue< T >::queue.

{ queue->Release(); queue.reset(); }

template<class T >

void CPN::IQueue< T >::Reset ( )

inline

Definition at line 90 of file IQueue.h.

References CPN::IQueue< T >::queue.

{ queue->Reset(); }

Member Data Documentation

template<class T >

shared_ptr<QueueReader> CPN::IQueue< T >::queue

private

Definition at line 111 of file IQueue.h.

Referenced by CPN::IQueue< T >::ChannelStride(), CPN::IQueue< T >::Count(), CPN::IQueue< T >::Dequeue(), CPN::IQueue< T >::Empty(), CPN::IQueue< T >::Flushed(), CPN::IQueue< T >::GetDequeuePtr(), CPN::IQueue< T >::GetKey(), CPN::IQueue< T >::GetReader(), CPN::IQueue< T >::IQueue(), CPN::IQueue< T >::MaxThreshold(), CPN::IQueue< T >::NumChannels(), CPN::IQueue< T >::QueueLength(), CPN::IQueue< T >::Release(), and CPN::IQueue< T >::Reset().

---

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

• include/cpn/IQueue.h