CPN::OQueue< T > Class Template Reference

A template class to do type conversion for the writer end of the queue. More...

#include <OQueue.h>

Collaboration diagram for CPN::OQueue< T >:

Public Member Functions
	OQueue ()
	OQueue (shared_ptr< QueueWriter > q)
T *	GetEnqueuePtr (unsigned thresh, unsigned chan=0)
void	Enqueue (unsigned count)
void	Enqueue (const T *data, unsigned count)
void	Enqueue (const T *data, unsigned count, unsigned numChans, unsigned chanStride)
void	Flush ()
bool	Flushed ()
unsigned	NumChannels () const
unsigned	MaxThreshold () const
unsigned	QueueLength () const
unsigned	Freespace () const
unsigned	ChannelStride () const
bool	Full () const
Key_t	GetKey () const
shared_ptr< QueueWriter >	GetWriter ()
void	Release ()
	Release the writer, further operations are invalid. More...

Private Attributes
shared_ptr< QueueWriter >	queue

Detailed Description

template<class T>
class CPN::OQueue< T >

A template class to do type conversion for the writer end of the queue.

Definition at line 41 of file OQueue.h.

Constructor & Destructor Documentation

template<class T >

CPN::OQueue< T >::OQueue ( )

inline

Definition at line 43 of file OQueue.h.

{}

template<class T >

CPN::OQueue< T >::OQueue ( shared_ptr< QueueWriter >  q )

inline

Definition at line 44 of file OQueue.h.

References CPN::OQueue< 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::OQueue< T >::ChannelStride ( ) const

inline

Returns

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

Definition at line 100 of file OQueue.h.

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

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

template<class T >

void CPN::OQueue< T >::Enqueue ( unsigned  count )

inline

Add count elements to the queue on all channels.

Parameters

count

the number of elements

Definition at line 64 of file OQueue.h.

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

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

template<class T >

void CPN::OQueue< T >::Enqueue ( const T *  data, unsigned  count  )

inline

Enqueue the count elements in the array data into this queue.

Parameters

data	the array
count	the number

Definition at line 73 of file OQueue.h.

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

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

template<class T >

void CPN::OQueue< T >::Enqueue ( const T *  data, unsigned  count, unsigned  numChans, unsigned  chanStride  )

inline

Enqueue the count elements in the 2D array into the channel.

Parameters

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

Definition at line 84 of file OQueue.h.

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

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

template<class T >

void CPN::OQueue< T >::Flush ( )

inline

Definition at line 89 of file OQueue.h.

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

{ queue->Flush(); }

template<class T >

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

inline

Definition at line 90 of file OQueue.h.

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

{ return queue->Flushed(); }

template<class T >

unsigned CPN::OQueue< T >::Freespace ( ) const

inline

Returns

the amount of freespace in data elements

Definition at line 98 of file OQueue.h.

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

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

template<class T >

bool CPN::OQueue< T >::Full ( ) const

inline

Returns

true if full

Definition at line 102 of file OQueue.h.

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

{ return queue->Full(); }

template<class T >

T* CPN::OQueue< T >::GetEnqueuePtr ( unsigned  thresh, unsigned  chan = 0  )

inline

Get an array to write into.

Parameters

thresh	the length of the array
chan	the number of channel to get the array from.

Returns

the array

Definition at line 56 of file OQueue.h.

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

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

template<class T >

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

inline

Returns

the endpoint key

Definition at line 104 of file OQueue.h.

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

{ return queue->GetKey(); }

template<class T >

shared_ptr<QueueWriter> CPN::OQueue< T >::GetWriter ( )

inline

Returns

the writer

Definition at line 106 of file OQueue.h.

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

{ return queue; }

template<class T >

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

inline

Returns

the maximum threshold in data elements

Definition at line 95 of file OQueue.h.

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

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

template<class T >

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

inline

Returns

the number of channels

Definition at line 93 of file OQueue.h.

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

{ return queue->NumChannels(); }

template<class T >

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

inline

Definition at line 96 of file OQueue.h.

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

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

template<class T >

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

inline

Release the writer, further operations are invalid.

Definition at line 108 of file OQueue.h.

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

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

Member Data Documentation

template<class T >

shared_ptr<QueueWriter> CPN::OQueue< T >::queue

private

Definition at line 111 of file OQueue.h.

Referenced by CPN::OQueue< T >::ChannelStride(), CPN::OQueue< T >::Enqueue(), CPN::OQueue< T >::Flush(), CPN::OQueue< T >::Flushed(), CPN::OQueue< T >::Freespace(), CPN::OQueue< T >::Full(), CPN::OQueue< T >::GetEnqueuePtr(), CPN::OQueue< T >::GetKey(), CPN::OQueue< T >::GetWriter(), CPN::OQueue< T >::MaxThreshold(), CPN::OQueue< T >::NumChannels(), CPN::OQueue< T >::OQueue(), CPN::OQueue< T >::QueueLength(), and CPN::OQueue< T >::Release().

---

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

• include/cpn/OQueue.h