nmea_protocolhandler.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 NMEA_PROTOCOLHANDLER_H
66 #define NMEA_PROTOCOLHANDLER_H
67 
68 #include "iprotocolhandler.h"
69 #include "xsprotocoltype.h"
70 #include <xstypes/xsdatapacket.h>
71 #include <xstypes/xsbytearray.h>
72 
73 namespace nmea
74 {
75 
76 class ProtocolHandler : public virtual IProtocolHandler
77 {
78 public:
80  virtual ~ProtocolHandler() throw();
81 
82  MessageLocation findMessage(XsProtocolType& type, const XsByteArray& raw) const override;
83  XsMessage convertToMessage(MessageLocation& location, const XsByteArray& raw) const override;
84  int minimumMessageSize() const override;
85  int maximumMessageSize() const override;
86  int type() const override;
87 
88 private:
89  static const int MINIMUM_MESSAGE_SIZE = 16;
90  static const int MAXIMUM_MESSAGE_SIZE = 128;
91 };
92 
93 }
94 
95 #endif
XsByteArray
A list of uint8_t values.
nmea::ProtocolHandler::findMessage
MessageLocation findMessage(XsProtocolType &type, const XsByteArray &raw) const override
Find the first message in the raw byte stream.
Definition: nmea_protocolhandler.cpp:96
nmea
Definition: nmea_protocolhandler.cpp:68
nmea::ProtocolHandler::MAXIMUM_MESSAGE_SIZE
static const int MAXIMUM_MESSAGE_SIZE
Definition: nmea_protocolhandler.h:90
nmea::ProtocolHandler
The protocol handler for a different NMEA data types.
Definition: nmea_protocolhandler.h:76
iprotocolhandler.h
xsprotocoltype.h
nmea::ProtocolHandler::type
int type() const override
Definition: nmea_protocolhandler.cpp:173
IProtocolHandler
Interface class for protocol handlers.
Definition: iprotocolhandler.h:78
xsdatapacket.h
XsMessage
Structure for storing a single message.
Definition: xsmessage.h:202
nmea::ProtocolHandler::MINIMUM_MESSAGE_SIZE
static const int MINIMUM_MESSAGE_SIZE
Definition: nmea_protocolhandler.h:89
nmea::ProtocolHandler::ProtocolHandler
ProtocolHandler()
Default constructor.
Definition: nmea_protocolhandler.cpp:84
nmea::ProtocolHandler::~ProtocolHandler
virtual ~ProtocolHandler()
Deafult destructor.
Definition: nmea_protocolhandler.cpp:90
XsProtocolType
XsProtocolType
Protocol types (XsDevice::enableProtocol())
Definition: xsprotocoltype.h:72
nmea::ProtocolHandler::minimumMessageSize
int minimumMessageSize() const override
Definition: nmea_protocolhandler.cpp:160
xsbytearray.h
nmea::ProtocolHandler::convertToMessage
XsMessage convertToMessage(MessageLocation &location, const XsByteArray &raw) const override
Converts raw data using location into a XsMessage object.
Definition: nmea_protocolhandler.cpp:151
MessageLocation
Stores the location of a message in a buffer using a start position and a size.
Definition: messagelocation.h:70
nmea::ProtocolHandler::maximumMessageSize
int maximumMessageSize() const override
Definition: nmea_protocolhandler.cpp:167


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