XnQueue.h

Go to the documentation of this file.

/*****************************************************************************
*                                                                            *
*  OpenNI 1.0 Alpha                                                          *
*  Copyright (C) 2010 PrimeSense Ltd.                                        *
*                                                                            *
*  This file is part of OpenNI.                                              *
*                                                                            *
*  OpenNI is free software: you can redistribute it and/or modify            *
*  it under the terms of the GNU Lesser General Public License as published  *
*  by the Free Software Foundation, either version 3 of the License, or      *
*  (at your option) any later version.                                       *
*                                                                            *
*  OpenNI 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 Lesser General Public License for more details.                       *
*                                                                            *
*  You should have received a copy of the GNU Lesser General Public License  *
*  along with OpenNI. If not, see <http://www.gnu.org/licenses/>.            *
*                                                                            *
*****************************************************************************/




#ifndef _XN_QUEUE_H
#define _XN_QUEUE_H

//---------------------------------------------------------------------------
// Includes
//---------------------------------------------------------------------------
#include "XnList.h"

//---------------------------------------------------------------------------
// Types
//---------------------------------------------------------------------------
class XnQueue
{
public:
        XnQueue() {}
        virtual ~XnQueue() {}

        virtual XnStatus Init()
        {
                return (XN_STATUS_OK);
        }

        virtual XnStatus Push(XnValue const& value)
        {
                XnStatus nRetVal = XN_STATUS_OK;

                nRetVal = m_List.AddLast(value);
                XN_IS_STATUS_OK(nRetVal);

                return (XN_STATUS_OK);
        }
        virtual XnStatus Pop(XnValue& value)
        {
                if (IsEmpty())
                {
                        return XN_STATUS_IS_EMPTY;
                }

                value = *(m_List.begin());
                return m_List.Remove(m_List.begin());
        }

        XnValue const& Top() const
        {
                return *(m_List.begin());
        }

        XnValue& Top()
        {
                return *(m_List.begin());
        }

        XnBool IsEmpty() const
        {
                return m_List.IsEmpty();
        }

        virtual XnUInt32 Size() const
        {
                return m_List.Size();
        }

private:
        XnList m_List;
};

#define XN_DECLARE_QUEUE_WITH_TRANSLATOR_DECL(decl, Type, ClassName, Translator, base)  \
        class decl ClassName : public base                                                                                                      \
        {                                                                                                                                                                       \
        public:                                                                                                                                                         \
                ~ClassName()                                                                                                                                    \
                {                                                                                                                                                               \
                        /* We do this using Pop() to make sure memory is freed. */                                      \
                        Type dummy;                                                                                                                                     \
                        while (Size() != 0)                                                                                                                     \
                                Pop(dummy);                                                                                                                             \
                }                                                                                                                                                               \
                XnStatus Push(Type const& value)                                                                                                \
                {                                                                                                                                                               \
                        XnValue val = Translator::CreateValueCopy(value);                                                       \
                        XnStatus nRetVal = base::Push(val);                                                                                     \
                        if (nRetVal != XN_STATUS_OK)                                                                                            \
                        {                                                                                                                                                       \
                                Translator::FreeValue(val);                                                                                             \
                                return (nRetVal);                                                                                                               \
                        }                                                                                                                                                       \
                        return XN_STATUS_OK;                                                                                                            \
                }                                                                                                                                                               \
                XnStatus Pop(Type& value)                                                                                                               \
                {                                                                                                                                                               \
                        XnValue val;                                                                                                                            \
                        XnStatus nRetVal = base::Pop(val);                                                                                      \
                        if (nRetVal != XN_STATUS_OK) return (nRetVal);                                                          \
                        value = Translator::GetFromValue(val);                                                                          \
                        return XN_STATUS_OK;                                                                                                            \
                }                                                                                                                                                               \
                inline Type const& Top() const { return Translator::GetFromValue(base::Top()); }\
                inline Type& Top() { return Translator::GetFromValue(base::Top()); }                    \
        };

#define XN_DECLARE_QUEUE_WITH_TRANSLATOR(Type, ClassName, Translator, base)                             \
        XN_DECLARE_QUEUE_WITH_TRANSLATOR_DECL(, Type, ClassName, Translator, base)

#define XN_DECLARE_QUEUE_DECL(decl, Type, ClassName)                                                                                                    \
        XN_DECLARE_DEFAULT_VALUE_TRANSLATOR_DECL(decl, Type, XN_DEFAULT_TRANSLATOR_NAME(ClassName))                     \
        XN_DECLARE_QUEUE_WITH_TRANSLATOR_DECL(decl, Type, ClassName, XN_DEFAULT_TRANSLATOR_NAME(ClassName), XnQueue)

#define XN_DECLARE_QUEUE(Type, ClassName)               \
        XN_DECLARE_QUEUE_DECL(, Type, ClassName)

#endif // _XN_QUEUE_H