xsusbhubinfo.h
Go to the documentation of this file.
1 
2 // Copyright (c) 2003-2021 Xsens Technologies B.V. or subsidiaries worldwide.
3 // All rights reserved.
4 //
5 // Redistribution and use in source and binary forms, with or without modification,
6 // are permitted provided that the following conditions are met:
7 //
8 // 1. Redistributions of source code must retain the above copyright notice,
9 // this list of conditions, and the following disclaimer.
10 //
11 // 2. Redistributions in binary form must reproduce the above copyright notice,
12 // this list of conditions, and the following disclaimer in the documentation
13 // and/or other materials provided with the distribution.
14 //
15 // 3. Neither the names of the copyright holders nor the names of their contributors
16 // may be used to endorse or promote products derived from this software without
17 // specific prior written permission.
18 //
19 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY
20 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
21 // MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
22 // THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23 // SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
24 // OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25 // HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY OR
26 // TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
27 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.THE LAWS OF THE NETHERLANDS
28 // SHALL BE EXCLUSIVELY APPLICABLE AND ANY DISPUTES SHALL BE FINALLY SETTLED UNDER THE RULES
29 // OF ARBITRATION OF THE INTERNATIONAL CHAMBER OF COMMERCE IN THE HAGUE BY ONE OR MORE
30 // ARBITRATORS APPOINTED IN ACCORDANCE WITH SAID RULES.
31 //
32 
33 
34 // Copyright (c) 2003-2021 Xsens Technologies B.V. or subsidiaries worldwide.
35 // All rights reserved.
36 //
37 // Redistribution and use in source and binary forms, with or without modification,
38 // are permitted provided that the following conditions are met:
39 //
40 // 1. Redistributions of source code must retain the above copyright notice,
41 // this list of conditions, and the following disclaimer.
42 //
43 // 2. Redistributions in binary form must reproduce the above copyright notice,
44 // this list of conditions, and the following disclaimer in the documentation
45 // and/or other materials provided with the distribution.
46 //
47 // 3. Neither the names of the copyright holders nor the names of their contributors
48 // may be used to endorse or promote products derived from this software without
49 // specific prior written permission.
50 //
51 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY
52 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
53 // MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
54 // THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
55 // SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
56 // OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
57 // HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY OR
58 // TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
59 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.THE LAWS OF THE NETHERLANDS
60 // SHALL BE EXCLUSIVELY APPLICABLE AND ANY DISPUTES SHALL BE FINALLY SETTLED UNDER THE RULES
61 // OF ARBITRATION OF THE INTERNATIONAL CHAMBER OF COMMERCE IN THE HAGUE BY ONE OR MORE
62 // ARBITRATORS APPOINTED IN ACCORDANCE WITH SAID RULES.
63 //
64 
65 #ifndef XSUSBHUBINFO_H
66 #define XSUSBHUBINFO_H
67 
68 #include "xscontrollerconfig.h"
69 
70 #ifdef _WIN32
71  typedef int XsHubIdentifier;
72 #else
73  typedef const char* XsHubIdentifier;
74 #endif
75 
76 struct XsUsbHubInfo;
77 #ifndef __cplusplus
78 #define XSUSBHUBINFO_INITIALIZER { 0 }
79 typedef struct XsUsbHubInfo XsUsbHubInfo;
80 #else
81 extern "C" {
82 #endif
83 
90 
91 #ifdef __cplusplus
92 } // extern "C"
93 #endif
94 
95 
100 {
101 #ifdef __cplusplus
102 
107  explicit XsUsbHubInfo(XsHubIdentifier hubid = 0)
108  : m_hub(0)
109  {
110  if (hubid)
111  XsUsbHubInfo_construct(this, hubid);
112  }
113 
115  ~XsUsbHubInfo()
116  {
117  XsUsbHubInfo_destruct(this);
118  }
119 
124  XsUsbHubInfo(const XsUsbHubInfo& other)
125  : m_hub(0)
126  {
127  if (other.m_hub)
128  XsUsbHubInfo_construct(this, other.m_hub);
129  }
130 
136  const XsUsbHubInfo& operator=(const XsUsbHubInfo& other)
137  {
138  if (this != &other)
139  XsUsbHubInfo_copy(this, &other);
140  return *this;
141  }
142 
148  bool parentPathMatches(const XsUsbHubInfo& other) const
149  {
150  return 0 != XsUsbHubInfo_parentPathMatches(this, &other);
151  }
152 
155  bool isValid() const
156  {
157  return m_hub != 0;
158  }
159 
162  inline XsHubIdentifier hub() const
163  {
164  return m_hub;
165  }
166 
167 private:
169 #endif
171 };
172 typedef struct XsUsbHubInfo XsUsbHubInfo;
173 
174 #endif
XDA_DLL_API
#define XDA_DLL_API
Definition: xscontrollerconfig.h:161
XsUsbHubInfo_copy
void XDA_DLL_API XsUsbHubInfo_copy(XsUsbHubInfo *copy, XsUsbHubInfo const *src)
Copy the contents of the XsUsbHubInfo to copy.
Definition: xsusbhubinfo.c:122
XsUsbHubInfo_swap
void XDA_DLL_API XsUsbHubInfo_swap(XsUsbHubInfo *thisPtr, XsUsbHubInfo *thatPtr)
Swap the two XsUsbHubInfo items.
Definition: xsusbhubinfo.c:130
XsUsbHubInfo_assign
void XDA_DLL_API XsUsbHubInfo_assign(XsUsbHubInfo *thisPtr, XsHubIdentifier hub)
Assign a new hub identifier to the XsUsbHubInfo.
Definition: xsusbhubinfo.c:114
XsHubIdentifier
const typedef char * XsHubIdentifier
Definition: xsusbhubinfo.h:73
XsUsbHubInfo
A structure that wraps USB hub information.
Definition: xsusbhubinfo.h:99
XsUsbHubInfo::m_hub
XsHubIdentifier m_hub
The identifier of the USB hub.
Definition: xsusbhubinfo.h:170
XsUsbHubInfo_construct
void XDA_DLL_API XsUsbHubInfo_construct(XsUsbHubInfo *thisPtr, XsHubIdentifier hub)
Initialize the XsUsbHubInfo with hub.
Definition: xsusbhubinfo.c:88
XsUsbHubInfo
struct XsUsbHubInfo XsUsbHubInfo
Definition: xsusbhubinfo.h:79
XsUsbHubInfo_destruct
void XDA_DLL_API XsUsbHubInfo_destruct(XsUsbHubInfo *thisPtr)
Destroy the XsUsbHubInfo.
Definition: xsusbhubinfo.c:102
xscontrollerconfig.h
XsUsbHubInfo_parentPathMatches
int XDA_DLL_API XsUsbHubInfo_parentPathMatches(const XsUsbHubInfo *thisPtr, const XsUsbHubInfo *other)
Returns true if the two hub info objects share the same device path.
Definition: xsusbhubinfo.c:148


xsens_mti_driver
Author(s):
autogenerated on Sun Sep 3 2023 02:43:20