Release v0.9.2

CMakeLists.txt

@@ -68,7 +68,7 @@ set (CC_EXTERNAL_TGT "comms_champion_external")
 macro (externals install_dir build_cc)
  include(ExternalProject)
 
- set (cc_tag "v0.23")
+ set (cc_tag "v0.24")
  set (cc_main_dir "${CMAKE_BINARY_DIR}/comms_champion")
  set (cc_src_dir "${cc_main_dir}/src")
  set (cc_bin_dir "${cc_main_dir}/build")

include/ublox/Message.h

@@ -28,8 +28,7 @@ namespace ublox
 {
 
 /// @brief Interface class of all the Ublox binary protocol messages.
-/// @details The class publicly inherits from
-/// <a href="https://dl.dropboxusercontent.com/u/46999418/comms_champion/comms/html/classcomms_1_1Message.html" target="_black">comms::Message</a>
+/// @details The class publicly inherits from @b comms::Message
 /// class while providing the following default options:
 /// @li @b comms::option::MsgIdType<MsgId> > - use @ref MsgId as the type of message ID.
 /// @li @b comms::option::LittleEndian - use little endian for serialisation

include/ublox/Stack.h

@@ -23,6 +23,7 @@
 
 #include "comms/comms.h"
 
+#include "version.h"
 #include "Message.h"
 #include "field/MsgId.h"
 #include "protocol/ChecksumCalc.h"
@@ -92,10 +93,9 @@ using DataField =
 /// @details It is used to process incoming binary stream of data and create
 /// allocate message objects for received messages. It also responsible to
 /// serialise outgoing messages and wrap their payload with appropriate transport
-/// information. See <a href="https://dl.dropboxusercontent.com/u/46999418/comms_champion/comms/html/page_prot_stack_tutorial.html">Protocol Stack Tutorial</a>
+/// information. See <b>Protocol Stack Definition Tutorial</b>
 /// page in @b COMMS library tutorial for more information.@n
-/// The outermost layer is
-/// <a href="https://dl.dropboxusercontent.com/u/46999418/comms_champion/comms/html/classcomms_1_1protocol_1_1SyncPrefixLayer.html">comms::protocol::SyncPrefixLayer</a>.
+/// The outermost layer is @b comms::protocol::SyncPrefixLayer.
 /// Please see its documentation for public interface description.
 /// @tparam TMsgBase Interface class for all the @b input messages, expected to be some
 /// variant of ublox::MessageT class with options.
@@ -121,8 +121,8 @@ using DataField =
 template <
  typename TMsgBase,
  typename TMessages,
- typename TMsgAllocOptions = std::tuple<>,
- typename TDataFieldStorageOptions = std::tuple<> >
+ typename TMsgAllocOptions = comms::option::EmptyOption,
+ typename TDataFieldStorageOptions = comms::option::EmptyOption>
 using Stack =
  comms::protocol::SyncPrefixLayer<
  details::SyncField1<typename TMsgBase::Field>,
@@ -137,9 +137,7 @@ using Stack =
  TMessages,
  comms::protocol::MsgSizeLayer<
  details::LengthField<typename TMsgBase::Field>,
- comms::protocol::MsgDataLayer<
- details::DataField<typename TMsgBase::Field, TDataFieldStorageOptions>
- >
+ comms::protocol::MsgDataLayer<TDataFieldStorageOptions>
  >,
  TMsgAllocOptions
  >

include/ublox/field/MsgId.h

@@ -357,8 +357,6 @@ struct MsgIdValueValidator
 } // namespace details
 
 /// @brief Definition of the field that represents message ID.
-/// @details See <a href="https://dl.dropboxusercontent.com/u/46999418/comms_champion/comms/html/classcomms_1_1field_1_1EnumValue.html">comms::field::EnumValue</a>
-/// for details.
 using MsgId =
  comms::field::EnumValue<
  comms::Field<comms::option::BigEndian>,

include/ublox/protocol/ChecksumCalc.h

@@ -30,8 +30,7 @@ namespace protocol
 {
 
 /// @brief Checksum calculator.
-/// @details Provided to
-/// <a href="https://dl.dropboxusercontent.com/u/46999418/comms_champion/comms/html/classcomms_1_1protocol_1_1ChecksumLayer.html">comms::protocol::ChecksumLayer</a>
+/// @details Provided to @b comms::protocol::ChecksumLayer
 /// when defining protocol stack (@ref ublox::Stack).
 struct ChecksumCalc
 {

include/ublox/ublox.h

@@ -21,6 +21,7 @@
 
 #pragma once
 
+#include "version.h"
 #include "MsgId.h"
 #include "Message.h"
 #include "Stack.h"

include/ublox/version.h

@@ -0,0 +1,76 @@
+//
+// Copyright 2018 (C). Alex Robenko. All rights reserved.
+//
+
+// This file is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with this program. If not, see <https://www.gnu.org/licenses/>.
+
+/// @file
+/// @brief Contains version of the library.
+
+#pragma once
+
+
+#include "comms/version.h"
+
+/// @brief Major verion of the library
+#define UBLOX_MAJOR_VERSION 0U
+
+/// @brief Minor verion of the library
+#define UBLOX_MINOR_VERSION 9U
+
+/// @brief Patch level of the library
+#define UBLOX_PATCH_VERSION 2U
+
+/// @brief Version of the UBLOX library as single numeric value
+#define UBLOX_VERSION \
+ COMMS_MAKE_VERSION(UBLOX_MAJOR_VERSION, UBLOX_MINOR_VERSION, UBLOX_PATCH_VERSION)
+
+
+namespace ublox
+{
+
+/// @brief Major verion of the library
+inline
+constexpr unsigned versionMajor()
+{
+ return UBLOX_MAJOR_VERSION;
+}
+
+/// @brief Minor verion of the library
+inline
+constexpr unsigned versionMinor()
+{
+ return UBLOX_MINOR_VERSION;
+}
+
+/// @brief Patch level of the library
+inline
+constexpr unsigned versionPatch()
+{
+ return UBLOX_PATCH_VERSION;
+}
+
+/// @brief Version of the COMMS library as single numeric value
+inline
+constexpr unsigned version()
+{
+ return UBLOX_VERSION;
+}
+
+static_assert(comms::versionCreate(0U, 24U, 0U) <= comms::version(),
+ "COMMS library needs to be updgraded");
+
+} // namespace ublox
+
+