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
|
/****************************************************************************
* *
* 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 _XNV_MODULE_H_
#define _XNV_MODULE_H_
//---------------------------------------------------------------------------
// Includes
//---------------------------------------------------------------------------
#include <XnOS.h>
#include "XnVStreamContainer.h"
#include "XnVStatus.h"
//---------------------------------------------------------------------------
// Types
//---------------------------------------------------------------------------
/**
* A module represents a number of parameters under the same title.
* Module and Property names are available in XnStreamParams.
*/
class XN_EE_CORE_API XnVModule
{
public:
XnVModule();
XnVModule(const XnVModule& other);
XnVModule& operator=(const XnVModule& other);
virtual ~XnVModule();
/**
* Attach to a certain module in a certain container.
* Module names are
*
* @param [in] pStreamContainer The container (device) to attach
* @param [in] strName Name of the module.
*/
XnStatus Attach(XnVStreamContainer* pStreamContainer, const XnChar* strName);
/**
* Detach from the device.
*/
XnStatus Detach();
/**
* Get a 'sibling module' - another module from the same device.
*
* @param [in] strName Name of the other module
* @param [out] module The other module
*/
XnStatus GetOtherModule(const XnChar* strName, XnVModule& module);
const XnChar* GetName() const;
XnVStreamContainer* GetCreator();
const XnVStreamContainer* GetCreator() const;
/**
* Get a certain property from the module.
*
* @param [in] strProperty Name of the property
* @param [out] nValue Value of the property
*/
XnStatus GetProperty(const XnChar* strProperty, XnUInt64& nValue) const;
XnStatus GetProperty(const XnChar* strProperty, XnDouble& dValue) const;
XnStatus GetProperty(const XnChar* strProperty, XnChar* csValue) const;
XnStatus GetProperty(const XnChar* strProperty, const XnGeneralBuffer& gbValue) const;
XnStatus GetAllProperties(XnVPropertySet& PropertySet);
/**
* Set a certain property to the module.
*
* @param [in] strProperty Name of the property
* @param [in] nValue Value of the property
*/
XnStatus SetProperty(const XnChar* strProperty, XnUInt64 nValue);
XnStatus SetProperty(const XnChar* strProperty, XnDouble fValue);
XnStatus SetProperty(const XnChar* strProperty, const XnChar* strValue);
XnStatus SetProperty(const XnChar* strProperty, const XnGeneralBuffer& gbValue);
XnStatus RegisterForPropertyChangedEvent(const XnChar* strProperty, XnVModulePropertyChangedHandler* pHandler, XnCallbackHandle* phCallback);
XnStatus UnregisterFromPropertyChangedEvent(const XnChar* strProperty, XnCallbackHandle hCallback);
XN_3_6_API XnStatus GetProperty(const XnChar* strProperty, XnUInt8& nValue) const;
XN_3_6_API XnStatus GetProperty(const XnChar* strProperty, XnUInt16& nValue) const;
XN_3_6_API XnStatus GetProperty(const XnChar* strProperty, XnInt32& nValue) const;
XN_3_6_API XnStatus GetProperty(const XnChar* strProperty, XnUInt32& nValue) const;
XN_3_6_API XnStatus GetProperty(const XnChar* strProperty, XnFloat& fValue) const;
XN_3_6_API XnStatus GetProperty(const XnChar* strProperty, void*& pValue) const;
XN_3_6_API XnStatus SetProperty(const XnChar* strProperty, XnUInt8 nValue);
XN_3_6_API XnStatus SetProperty(const XnChar* strProperty, XnUInt16 nValue);
XN_3_6_API XnStatus SetProperty(const XnChar* strProperty, XnInt32 nValue);
XN_3_6_API XnStatus SetProperty(const XnChar* strProperty, XnUInt32 nValue);
XN_3_6_API XnStatus SetProperty(const XnChar* strProperty, XnFloat fValue);
XN_3_6_API XnStatus SetProperty(const XnChar* strProperty, void* pValue);
protected:
XnVStreamContainer* m_pStreamContainer;
XnChar* m_strModule;
XnBool m_bAttached;
};
#endif // XNV_MODULE_H
|
