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
|
/****************************************************************************
* *
* PrimeSense Sensor 5.x Alpha *
* Copyright (C) 2011 PrimeSense Ltd. *
* *
* This file is part of PrimeSense Sensor. *
* *
* PrimeSense Sensor 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. *
* *
* PrimeSense Sensor 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 PrimeSense Sensor. If not, see <http://www.gnu.org/licenses/>.*
* *
****************************************************************************/
#ifndef __XN_DEVICE_MODULE_H__
#define __XN_DEVICE_MODULE_H__
//---------------------------------------------------------------------------
// Includes
//---------------------------------------------------------------------------
#include <XnPlatform.h>
#include <XnStringsHash.h>
#include <XnDDK/XnPropertySetInternal.h>
#include <XnDDK/XnIntProperty.h>
#include <XnDDK/XnRealProperty.h>
#include <XnDDK/XnStringProperty.h>
#include <XnDDK/XnGeneralProperty.h>
//---------------------------------------------------------------------------
// Types
//---------------------------------------------------------------------------
/**
* Holds a set of properties related to a specific module.
*/
class XN_DDK_CPP_API XnDeviceModule
{
public:
XnDeviceModule(const XnChar* strName);
virtual ~XnDeviceModule();
virtual XnStatus Init();
virtual XnStatus Free();
inline const XnChar* GetName() const { return m_strName; }
XnStatus AddProperty(XnProperty* pProperty);
XnStatus AddProperties(XnProperty** apProperties, XnUInt32 nCount);
XnStatus DoesPropertyExist(const XnChar* strName, XnBool* pbDoesExist) const;
XnStatus GetPropertyType(const XnChar* strName, XnPropertyType* pnType) const;
XnStatus GetProperty(const XnChar* strName, XnProperty** ppProperty) const;
virtual XnStatus GetProperty(const XnChar* strName, XnUInt64* pnValue) const;
virtual XnStatus GetProperty(const XnChar* strName, XnDouble* pdValue) const;
virtual XnStatus GetProperty(const XnChar* strName, XnChar* csValue) const;
virtual XnStatus GetProperty(const XnChar* strName, const XnGeneralBuffer& gbValue) const;
virtual XnStatus SetProperty(const XnChar* strName, XnUInt64 nValue);
virtual XnStatus SetProperty(const XnChar* strName, XnDouble dValue);
virtual XnStatus SetProperty(const XnChar* strName, const XnChar* strValue);
virtual XnStatus SetProperty(const XnChar* strName, const XnGeneralBuffer& gbValue);
virtual XnStatus UnsafeUpdateProperty(const XnChar* strName, XnUInt64 nValue);
virtual XnStatus UnsafeUpdateProperty(const XnChar* strName, XnDouble dValue);
virtual XnStatus UnsafeUpdateProperty(const XnChar* strName, const XnChar* strValue);
virtual XnStatus UnsafeUpdateProperty(const XnChar* strName, const XnGeneralBuffer& gbValue);
XnStatus GetAllProperties(XnPropertySet* pSet) const;
XnStatus RegisterForOnPropertyValueChanged(const XnChar* strName, XnProperty::OnValueChangedHandler pFunc, void* pCookie, XnCallbackHandle* pHandle);
XnStatus UnregisterFromOnPropertyValueChanged(const XnChar* strName, XnCallbackHandle hCallback);
/**
* Reads values for all properties in module from an INI file.
*/
XnStatus LoadConfigFromFile(const XnChar* csINIFilePath, const XnChar* strSectionName = NULL);
virtual XnStatus BatchConfig(const XnActualPropertiesHash& props);
virtual XnStatus UnsafeBatchConfig(const XnActualPropertiesHash& props);
XnStatus GetProperty(const XnChar* strName, XnIntProperty** ppIntProperty) const;
XnStatus GetProperty(const XnChar* strName, XnRealProperty** ppRealProperty) const;
XnStatus GetProperty(const XnChar* strName, XnStringProperty** ppStringProperty) const;
XnStatus GetProperty(const XnChar* strName, XnGeneralProperty** ppGeneralProperty) const;
private:
XnStatus GetPropertyImpl(const XnChar* Name, XnPropertyType Type, XnProperty** ppProperty) const;
XnStatus SetLockState(XnBool bLocked);
static XnStatus XN_CALLBACK_TYPE SetLockStateCallback(XnActualIntProperty* pSender, XnUInt64 nValue, void* pCookie);
XnChar m_strName[XN_DEVICE_MAX_STRING_LENGTH];
XnPropertiesHash m_Properties;
XnActualIntProperty m_Lock;
XN_CRITICAL_SECTION_HANDLE m_hLockCS;
};
#define XN_VALIDATE_ADD_PROPERTIES(pModule, ...) \
{ \
XnProperty* _aProps[] = { __VA_ARGS__ }; \
XnStatus _nRetVal = (pModule)->AddProperties(_aProps, sizeof(_aProps)/sizeof(XnProperty*)); \
XN_IS_STATUS_OK(_nRetVal); \
}
#endif //__XN_DEVICE_MODULE_H__
|