restorecommunication.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 XSRESTORECOMMUNICATION_H
66 #define XSRESTORECOMMUNICATION_H
67 
68 #include "callbackmanagerxda.h"
69 #include <xscommon/threading.h>
70 
71 struct XsControl;
72 struct XsPortInfo;
73 class SerialInterface;
74 
76 {
77 public:
80 
81  XsResultValue start(const XsString& portName);
82  void stop();
83 
84 protected:
85  int32_t innerFunction(void) override;
86 
87 private:
88  XsResultValue openComPort(const XsPortInfo& portInfo);
89 
93 
94  volatile std::atomic<bool> m_isRestoring;
95 };
96 
97 #endif
RestoreCommunication::innerFunction
int32_t innerFunction(void) override
Inner function for an execution on a thread.
Definition: restorecommunication.cpp:144
RestoreCommunication::stop
void stop()
Stops the restore communication procedure.
Definition: restorecommunication.cpp:135
RestoreCommunication::openComPort
XsResultValue openComPort(const XsPortInfo &portInfo)
Tries to open COM port.
Definition: restorecommunication.cpp:197
RestoreCommunication::m_serialInterface
SerialInterface * m_serialInterface
Definition: restorecommunication.h:91
XsControl
High level Motion Tracker (MT) management class.
Definition: xscontrol_def.h:131
XsResultValue
XsResultValue
Xsens result values.
Definition: xsresultvalue.h:82
RestoreCommunication::m_isRestoring
volatile std::atomic< bool > m_isRestoring
Definition: restorecommunication.h:94
RestoreCommunication::start
XsResultValue start(const XsString &portName)
Starts the restore communication procedure.
Definition: restorecommunication.cpp:108
XsPortInfo
Contains a descriptor for opening a communication port to an Xsens device.
Definition: xsportinfo.h:128
RestoreCommunication::RestoreCommunication
RestoreCommunication(XsControl *control)
Constructor.
Definition: restorecommunication.cpp:81
RestoreCommunication::m_control
XsControl * m_control
Definition: restorecommunication.h:90
threading.h
SerialInterface
The low-level serial communication class.
Definition: serialinterface.h:82
xsens::StandardThread
A class for a standard thread that has to perform the same action repeatedly.
Definition: threading.h:83
RestoreCommunication
Performs restore communication procedure with a provided COM port.
Definition: restorecommunication.h:75
int32_t
signed int int32_t
Definition: pstdint.h:515
callbackmanagerxda.h
RestoreCommunication::~RestoreCommunication
~RestoreCommunication()
Destructor.
Definition: restorecommunication.cpp:91
CallbackManagerXda
Class that delegates callbacks to registered XsCallbackHandlerItems.
Definition: callbackmanagerxda.h:78
XsString
A 0-terminated managed string of characters.
RestoreCommunication::m_portName
XsString m_portName
Definition: restorecommunication.h:92


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