IQueue.h

Go to the documentation of this file.

//=============================================================================
//  Computational Process Networks class library
//  Copyright (C) 1997-2006  Gregory E. Allen and The University of Texas
//
//  This library is free software; you can redistribute it and/or modify it
//  under the terms of the GNU Library General Public License as published
//  by the Free Software Foundation; either version 2 of the License, or
//  (at your option) any later version.
//
//  This library is distributed in the hope that it will be useful,
//  but WITHOUT ANY WARRANTY; without even the implied warranty of
//  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
//  Library General Public License for more details.
//
//  The GNU Public License is available in the file LICENSE, or you
//  can write to the Free Software Foundation, Inc., 59 Temple Place -
//  Suite 330, Boston, MA 02111-1307, USA, or you can find it on the
//  World Wide Web at http://www.fsf.org.
//=============================================================================
#ifndef CPN_QUEUE_QUEUEREADERADAPTER_H
#define CPN_QUEUE_QUEUEREADERADAPTER_H
#pragma once

#include <cpn/common.h>
#include <cpn/bits/QueueReader.h>
#include <cpn/QueueDatatypes.h>
#include <cpn/Exceptions.h>

namespace CPN {
    template<class T>
    class IQueue {
    public:
        IQueue() {}
        IQueue(shared_ptr<QueueReader> q) : queue(q) {
            if (!TypeCompatable(TypeName<T>(), queue->GetDatatype())) {
                throw TypeMismatchException(TypeName<T>(), queue->GetDatatype());
            }
        }

        const T* GetDequeuePtr(unsigned thresh, unsigned chan=0) {
            return (T*) queue->GetRawDequeuePtr(GetTypeSize<T>() * thresh, chan);
        }

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

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

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

        void Reset() { queue->Reset(); }
        bool Flushed() { return queue->Flushed(); }

        unsigned NumChannels() const { return queue->NumChannels(); }
        unsigned MaxThreshold() const { return queue->MaxThreshold()/GetTypeSize<T>(); }
        unsigned QueueLength() const { return queue->QueueLength()/GetTypeSize<T>(); }
        unsigned Count() const { return queue->Count()/GetTypeSize<T>(); }
        bool Empty() const { return queue->Empty(); }
        unsigned ChannelStride() const { return queue->ChannelStride()/GetTypeSize<T>(); }
        Key_t GetKey() const { return queue->GetKey(); }
        shared_ptr<QueueReader> GetReader() { return queue; }
        void Release() { queue->Release(); queue.reset(); }
    private:
        shared_ptr<QueueReader> queue;
    };
}
#endif