messageextractor.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 MESSAGEEXTRACTOR_H
66 #define MESSAGEEXTRACTOR_H
67 
68 #include <xstypes/xsresultvalue.h>
69 #include <xstypes/xsmessage.h>
70 #include <deque>
71 #include <memory>
72 #include "xsdevice_def.h"
73 #include "iprotocolmanager.h"
74 
76 {
77 public:
78  MessageExtractor(std::shared_ptr<IProtocolManager> const& protocolManager);
79 
80  XsResultValue processNewData(XsDevice* devicePtr, XsByteArray const& newData, std::deque<XsMessage>& messages);
81 
82  void clearBuffer();
83  int setMaxIncompleteRetryCount(int max);
84 
85 private:
86  std::shared_ptr<IProtocolManager> m_protocolManager;
90 };
91 
92 
93 #endif
94 
iprotocolmanager.h
XsByteArray
A list of uint8_t values.
MessageExtractor::m_buffer
XsByteArray m_buffer
Definition: messageextractor.h:88
XsResultValue
XsResultValue
Xsens result values.
Definition: xsresultvalue.h:82
MessageExtractor::m_maxIncompleteRetryCount
int m_maxIncompleteRetryCount
Definition: messageextractor.h:89
MessageExtractor::MessageExtractor
MessageExtractor(std::shared_ptr< IProtocolManager > const &protocolManager)
Constructor.
Definition: messageextractor.cpp:83
xsdevice_def.h
MessageExtractor::m_retryTimeout
int m_retryTimeout
Definition: messageextractor.h:87
xsmessage.h
MessageExtractor
Definition: messageextractor.h:75
MessageExtractor::setMaxIncompleteRetryCount
int setMaxIncompleteRetryCount(int max)
Sets the maximum number of process attempts before advancing over an incompletely received message.
Definition: messageextractor.cpp:223
MessageExtractor::clearBuffer
void clearBuffer()
Clears the processing buffer.
Definition: messageextractor.cpp:213
MessageExtractor::processNewData
XsResultValue processNewData(XsDevice *devicePtr, XsByteArray const &newData, std::deque< XsMessage > &messages)
Processes new incoming data for message extraction.
Definition: messageextractor.cpp:98
xsresultvalue.h
MessageExtractor::m_protocolManager
std::shared_ptr< IProtocolManager > m_protocolManager
Definition: messageextractor.h:86
XsDevice
Definition: xsdevice_def.h:164


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