usbcommunicator.cpp
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 #include "usbcommunicator.h"
66 #include "usbinterface.h"
67 
76 {
77  return new UsbCommunicator;
78 }
79 
83  : m_usbInterface(nullptr)
84 {
85 }
86 
88 {
89 }
90 
94 {
96 
97  if (r == XRV_OK)
98  {
99  m_usbInterface->setRawIo(false);
101  }
102  return r;
103 }
104 
108 {
110  if (r == XRV_OK)
111  {
112  m_usbInterface->setRawIo(true);
113  m_usbInterface->setTimeout(2000);
114  }
115  return r;
116 }
117 
122 std::shared_ptr<StreamInterface> UsbCommunicator::createStreamInterface(const XsPortInfo& pi)
123 {
124  assert(pi.isUsb());
126  std::shared_ptr<StreamInterface> stream(m_usbInterface,
127  [this](StreamInterface * intf)
128  {
129  m_usbInterface = nullptr;
130  delete intf;
131  }
132  );
133 
135 
136  return stream;
137 }
usbcommunicator.h
StreamInterface
A stream interface.
Definition: streaminterface.h:75
XRV_OK
@ XRV_OK
0: Operation was performed successfully
Definition: xsresultvalue.h:85
UsbCommunicator::~UsbCommunicator
virtual ~UsbCommunicator()
Definition: usbcommunicator.cpp:87
UsbCommunicator::gotoConfig
virtual XsResultValue gotoConfig(bool detectRs485) override
Request a device to go to config mode.
Definition: usbcommunicator.cpp:93
XsResultValue
XsResultValue
Xsens result values.
Definition: xsresultvalue.h:82
Communicator
A base struct for a communication interface.
Definition: communicator.h:95
SerialCommunicator::gotoConfig
XsResultValue gotoConfig(bool detectRs485=false) override
Request a device to go to config mode.
Definition: serialcommunicator.cpp:138
XsPortInfo
Contains a descriptor for opening a communication port to an Xsens device.
Definition: xsportinfo.h:128
usbinterface.h
UsbCommunicator::createStreamInterface
std::shared_ptr< StreamInterface > createStreamInterface(const XsPortInfo &pi) override
Creates a stream interface.
Definition: usbcommunicator.cpp:122
UsbInterface::setTimeout
XsResultValue setTimeout(uint32_t ms)
Set the default timeout value to use in blocking operations.
Definition: usbinterface.cpp:912
UsbCommunicator::m_usbInterface
UsbInterface * m_usbInterface
Definition: usbcommunicator.h:86
UsbCommunicator::construct
static Communicator * construct()
Construct and returns new USB communicator.
Definition: usbcommunicator.cpp:75
UsbInterface::setRawIo
void setRawIo(bool enable)
Sets the RAWIO mode of the USB interface.
Definition: usbinterface.cpp:937
UsbInterface::open
XsResultValue open(const XsPortInfo &portInfo, XsFilePos readBufSize=0, XsFilePos writeBufSize=0, PortOptions=PO_XsensDefaults) override
Open a communication channel to the given USB port name.
Definition: usbinterface.cpp:584
UsbCommunicator::gotoMeasurement
virtual XsResultValue gotoMeasurement() override
Request a device to go to measurement mode.
Definition: usbcommunicator.cpp:107
UsbCommunicator::UsbCommunicator
UsbCommunicator()
Default constructor.
Definition: usbcommunicator.cpp:82
Communicator::setLastResult
void setLastResult(XsResultValue lastResult, XsString const &text=XsString()) const
Sets the last result.
Definition: communicator.cpp:238
UsbInterface
An IoInterface for dealing specifically with Xsens USB devices.
Definition: usbinterface.h:89
SerialCommunicator::gotoMeasurement
XsResultValue gotoMeasurement() override
Request a device to go to measurement mode.
Definition: serialcommunicator.cpp:121


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