summaryrefslogtreecommitdiffstats
path: root/tests/manual/kinectsurface/QtKinectWrapper/OpenNI/Include/XnEnumerationErrors.h
diff options
context:
space:
mode:
Diffstat (limited to 'tests/manual/kinectsurface/QtKinectWrapper/OpenNI/Include/XnEnumerationErrors.h')
-rw-r--r--tests/manual/kinectsurface/QtKinectWrapper/OpenNI/Include/XnEnumerationErrors.h142
1 files changed, 142 insertions, 0 deletions
diff --git a/tests/manual/kinectsurface/QtKinectWrapper/OpenNI/Include/XnEnumerationErrors.h b/tests/manual/kinectsurface/QtKinectWrapper/OpenNI/Include/XnEnumerationErrors.h
new file mode 100644
index 00000000..4a1d77ce
--- /dev/null
+++ b/tests/manual/kinectsurface/QtKinectWrapper/OpenNI/Include/XnEnumerationErrors.h
@@ -0,0 +1,142 @@
+/****************************************************************************
+* *
+* 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_ENUMERATION_ERRORS_H__
+#define __XN_ENUMERATION_ERRORS_H__
+
+//---------------------------------------------------------------------------
+// Includes
+//---------------------------------------------------------------------------
+#include <XnTypes.h>
+
+/**
+ * @ingroup cref
+ * @defgroup enum_errors Enumeration Errors
+ * This page details functions for managing an Enumeration Errors object.
+ *
+ * @section enum Enumeration
+ *
+ * The following code iterates over an enumeration errors object:
+ * @code
+for (XnEnumerationErrorsIterator it = xnEnumerationErrorsGetFirst(pList);
+ xnEnumerationErrorsIteratorIsValid(it);
+ it = xnEnumerationErrorsGetNext(it))
+{
+ const XnProductionNodeDescription* pCurrDesc = xnEnumerationErrorsGetCurrentDescription(it);
+ XnStatus nCurrError = xnEnumerationErrorsGetCurrentError(it);
+ ...
+}
+ * @endcode
+ * @{
+ */
+
+//---------------------------------------------------------------------------
+// Types
+//---------------------------------------------------------------------------
+/**
+ * Represents an iterator for an @ref XnEnumerationErrors object.
+ */
+typedef struct XnModuleError* XnEnumerationErrorsIterator;
+
+//---------------------------------------------------------------------------
+// Functions
+//---------------------------------------------------------------------------
+
+
+/**
+ * Allocates an enumeration errors object.
+ *
+ * @param ppErrors [out] The allocated object
+ */
+XN_C_API XnStatus XN_C_DECL xnEnumerationErrorsAllocate(XnEnumerationErrors** ppErrors);
+
+/**
+ * Frees an enumeration errors object
+ *
+ * @param pErrors [in] Parameter description
+ */
+XN_C_API void XN_C_DECL xnEnumerationErrorsFree(const XnEnumerationErrors* pErrors);
+
+/**
+ * Adds an error to the object.
+ *
+ * @param pErrors [in] Enumeration Errors object.
+ * @param pDesc [in] Description of the failing module.
+ * @param nError [in] The enumeration error that occurred.
+ */
+XN_C_API XnStatus XN_C_DECL xnEnumerationErrorsAdd(XnEnumerationErrors* pErrors, const XnProductionNodeDescription* pDesc, XnStatus nError);
+
+/**
+ * Returns a string representation of the Enumeration Errors object.
+ *
+ * @param pErrors [in] Enumeration Errors object.
+ * @param csBuffer [in] A char buffer to be filled.
+ * @param nSize [in] Size of the char buffer.
+ */
+XN_C_API XnStatus XN_C_DECL xnEnumerationErrorsToString(const XnEnumerationErrors* pErrors, XnChar* csBuffer, XnUInt32 nSize);
+
+/**
+ * Clears an Enumeration Errors object from all errors in it.
+ *
+ * @param pErrors [in] Enumeration Errors object.
+ */
+XN_C_API XnStatus XN_C_DECL xnEnumerationErrorsClear(XnEnumerationErrors* pErrors);
+
+/**
+ * Gets an iterator to the first error in the object.
+ *
+ * @param pErrors [in] Enumeration Errors object.
+ */
+XN_C_API XnEnumerationErrorsIterator XN_C_DECL xnEnumerationErrorsGetFirst(const XnEnumerationErrors* pErrors);
+
+/**
+ * Gets an iterator to the next error in the object.
+ *
+ * @param it [in] An iterator to an error in the object.
+ */
+XN_C_API XnEnumerationErrorsIterator XN_C_DECL xnEnumerationErrorsGetNext(XnEnumerationErrorsIterator it);
+
+/**
+ * Checks if an iterator is valid (i.e. points to a real error)
+ *
+ * @param it [in] The iterator to check.
+ */
+XN_C_API XnBool XN_C_DECL xnEnumerationErrorsIteratorIsValid(XnEnumerationErrorsIterator it);
+
+/**
+ * Gets the description of the node from current error.
+ *
+ * @param it [in] The iterator to the error.
+ */
+XN_C_API const XnProductionNodeDescription* XN_C_DECL xnEnumerationErrorsGetCurrentDescription(XnEnumerationErrorsIterator it);
+
+/**
+ * Gets the enumeration error caused when enumerating the node.
+ *
+ * @param it [in] The iterator to the error.
+ */
+XN_C_API XnStatus XN_C_DECL xnEnumerationErrorsGetCurrentError(XnEnumerationErrorsIterator it);
+
+/**
+ * @}
+ */
+
+#endif // __XN_ENUMERATION_ERRORS_H__