1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
|
/****************************************************************************
* *
* OpenNI 1.x Alpha *
* Copyright (C) 2011 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
//---------------------------------------------------------------------------
/**
* The queue
*/
class XnQueue
{
public:
/**
* Constructor. Initialize internal representations
*/
XnQueue() {}
/**
* Destructor. Destroy internal representations
*/
virtual ~XnQueue() {}
/**
* Initialized the queue. This method should be called before calling any other method.
*/
virtual XnStatus Init()
{
return (XN_STATUS_OK);
}
/**
* Push a new value to the queue
*
* @param value [in] The value to add to the queue
*
* @return XN_STATUS_ALLOC_FAILED Failed to add to the queue because no nodes are available.
*/
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);
}
/**
* Pop the value at the top of the queue
*
* @param value [out] The value that was at the top of the queue
*
* @return XN_STATUS_IS_EMPTY The queue is empty
*/
virtual XnStatus Pop(XnValue& value)
{
if (IsEmpty())
{
return XN_STATUS_IS_EMPTY;
}
value = *(m_List.begin());
return m_List.Remove(m_List.begin());
}
/**
* Get the value at the top of the queue (it is user responsibility to check queue is not empty)
*
* @return a reference to the object at head of the queue.
*/
XnValue const& Top() const
{
return *(m_List.begin());
}
/**
* Get the value at the top of the queue (it is user responsibility to check queue is not empty)
*
* @return a reference to the object at head of the queue.
*/
XnValue& Top()
{
return *(m_List.begin());
}
/**
* Check if queue is empty
*/
XnBool IsEmpty() const
{
return m_List.IsEmpty();
}
/**
* Get current size of queue
*/
virtual XnUInt32 Size() const
{
return m_List.Size();
}
private:
XN_DISABLE_COPY_AND_ASSIGN(XnQueue);
/** The internal XnList with which the queue is implemented. */
XnList m_List;
};
/**
* Declares a queue of type @a Type, named @a ClassName. The class uses @a Translator for translating
* from @a Type to XnValue. It is declared using the declspec @a decl.
* It inherits from @a base. Note that @a base must be a derivative of XnQueue.
*/
#define XN_DECLARE_QUEUE_WITH_TRANSLATOR_DECL(decl, Type, ClassName, Translator, base) \
class decl ClassName : public base \
{ \
public: \
ClassName() {} \
~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); \
Translator::FreeValue(val); \
return XN_STATUS_OK; \
} \
inline Type const& Top() const { return Translator::GetFromValue(base::Top()); }\
inline Type& Top() { return Translator::GetFromValue(base::Top()); } \
private: \
XN_DISABLE_COPY_AND_ASSIGN(ClassName); \
};
/**
* Declares a queue of type @a Type, named @a ClassName. The class uses @a Translator for translating
* from @a Type to XnValue.
* It inherits from @a base. Note that @a base must be a derivative of XnQueue.
*/
#define XN_DECLARE_QUEUE_WITH_TRANSLATOR(Type, ClassName, Translator, base) \
XN_DECLARE_QUEUE_WITH_TRANSLATOR_DECL(, Type, ClassName, Translator, base)
/**
* Declares a queue of type @a Type, named @a ClassName, that uses the default translator.
* It is declared using the declspec @a decl.
*/
#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)
/**
* Declares a queue of type @a Type, named @a ClassName, that uses the default translator.
*/
#define XN_DECLARE_QUEUE(Type, ClassName) \
XN_DECLARE_QUEUE_DECL(, Type, ClassName)
#endif // _XN_QUEUE_H
|
