COMMS
Template library intended to help with implementation of communication protocols.
Loading...
Searching...
No Matches
Bitfield.h
Go to the documentation of this file.
1//
2// Copyright 2015 - 2025 (C). Alex Robenko. All rights reserved.
3//
4// This Source Code Form is subject to the terms of the Mozilla Public
5// License, v. 2.0. If a copy of the MPL was not distributed with this
6// file, You can obtain one at http://mozilla.org/MPL/2.0/.
7
10
11#pragma once
12
13#include "comms/ErrorStatus.h"
14#include "comms/field/basic/Bitfield.h"
15#include "comms/field/details/AdaptBasicField.h"
16#include "comms/options.h"
17
18#include <utility>
19
20namespace comms
21{
22
23namespace field
24{
25
83
93template <typename TFieldBase, typename TMembers, typename... TOptions>
94class Bitfield : public
95 details::AdaptBasicFieldT<
96 basic::Bitfield<
97 TFieldBase,
98 details::OptionsParser<TOptions...>::ForcedMembersVersionDependency,
99 TMembers
100 >,
101 TOptions...
102 >
103{
104 using BaseImpl =
105 details::AdaptBasicFieldT<
106 basic::Bitfield<
107 TFieldBase,
108 details::OptionsParser<TOptions...>::ForcedMembersVersionDependency,
109 TMembers
110 >,
111 TOptions...
112 >;
113
114public:
116 using FieldBase = TFieldBase;
117
119 using Endian = typename BaseImpl::Endian;
120
122 using VersionType = typename BaseImpl::VersionType;
123
125 using ParsedOptions = details::OptionsParser<TOptions...>;
126
128 using CommsTag = typename BaseImpl::CommsTag;
129
133 using ValueType = typename BaseImpl::ValueType;
134
138 using FieldType = typename ParsedOptions::FieldType;
139
142 Bitfield() = default;
143
146 explicit Bitfield(const ValueType& val)
147 : BaseImpl(val)
148 {
149 }
150
153 explicit Bitfield(ValueType&& val)
154 : BaseImpl(std::move(val))
155 {
156 }
157
160 static constexpr bool hasFailOnInvalid()
161 {
162 return ParsedOptions::HasFailOnInvalid;
163 }
164
167 static constexpr bool hasIgnoreInvalid()
168 {
169 return ParsedOptions::HasIgnoreInvalid;
170 }
171
174 static constexpr bool hasEmptySerialization()
175 {
176 return ParsedOptions::HasEmptySerialization;
177 }
178
181 static constexpr bool hasFieldType()
182 {
183 return ParsedOptions::HasFieldType;
184 }
185
188 static constexpr bool hasFixedValue()
189 {
190 return ParsedOptions::HasFixedValue;
191 }
192
195 static constexpr bool hasName()
196 {
197 return ParsedOptions::HasName;
198 }
199
204 template <std::size_t TIdx>
205 static constexpr std::size_t memberBitLength()
206 {
207 return BaseImpl::template memberBitLength<TIdx>();
208 }
209
210
213 const ValueType& value() const
214 {
215 return BaseImpl::value();
216 }
217
221 {
222 return BaseImpl::value();
223 }
224
227 const ValueType& getValue() const
228 {
229 return BaseImpl::getValue();
230 }
231
234 template <typename U>
235 void setValue(U&& val)
236 {
237 BaseImpl::setValue(std::forward<U>(val));
238 }
239
242 constexpr std::size_t length() const
243 {
244 return BaseImpl::length();
245 }
246
249 static constexpr std::size_t minLength()
250 {
251 return BaseImpl::minLength();
252 }
253
256 static constexpr std::size_t maxLength()
257 {
258 return BaseImpl::maxLength();
259 }
260
266 template <typename TIter>
267 ErrorStatus read(TIter& iter, std::size_t size)
268 {
269 return BaseImpl::read(iter, size);
270 }
271
274 static constexpr bool hasReadNoStatus()
275 {
276 return BaseImpl::hasReadNoStatus();
277 }
278
284 template <typename TIter>
285 void readNoStatus(TIter& iter)
286 {
287 BaseImpl::readNoStatus(iter);
288 }
289
291 bool canWrite() const
292 {
293 return BaseImpl::canWrite();
294 }
295
301 template <typename TIter>
302 ErrorStatus write(TIter& iter, std::size_t size) const
303 {
304 return BaseImpl::write(iter, size);
305 }
306
309 static constexpr bool hasWriteNoStatus()
310 {
311 return BaseImpl::hasWriteNoStatus();
312 }
313
319 template <typename TIter>
320 void writeNoStatus(TIter& iter) const
321 {
322 BaseImpl::writeNoStatus(iter);
323 }
324
326 bool valid() const
327 {
328 return BaseImpl::valid();
329 }
330
334 bool refresh()
335 {
336 return BaseImpl::refresh();
337 }
338
340 static constexpr bool isVersionDependent()
341 {
342 return ParsedOptions::HasCustomVersionUpdate || BaseImpl::isVersionDependent();
343 }
344
346 static constexpr bool hasNonDefaultRefresh()
347 {
348 return BaseImpl::hasNonDefaultRefresh();
349 }
350
354 {
355 return BaseImpl::getVersion();
356 }
357
361 {
362 return BaseImpl::setVersion(version);
363 }
364
365protected:
366 using BaseImpl::readData;
367 using BaseImpl::writeData;
368
369private:
370 static_assert(!ParsedOptions::HasSerOffset,
371 "comms::option::def::NumValueSerOffset option is not applicable to Bitfield field");
372 static_assert(!ParsedOptions::HasFixedLengthLimit,
373 "comms::option::def::FixedLength option is not applicable to Bitfield field");
374 static_assert(!ParsedOptions::HasFixedBitLengthLimit,
375 "comms::option::def::FixedBitLength option is not applicable to Bitfield field");
376 static_assert(!ParsedOptions::HasVarLengthLimits,
377 "comms::option::def::VarLength option is not applicable to Bitfield field");
378 static_assert(!ParsedOptions::HasAvailableLengthLimit,
379 "comms::option::def::AvailableLengthLimit option is not applicable to Bitfield field");
380 static_assert(!ParsedOptions::HasSequenceElemLengthForcing,
381 "comms::option::def::SequenceElemLengthForcingEnabled option is not applicable to Bitfield field");
382 static_assert(!ParsedOptions::HasSequenceSizeForcing,
383 "comms::option::def::SequenceSizeForcingEnabled option is not applicable to Bitfield field");
384 static_assert(!ParsedOptions::HasSequenceLengthForcing,
385 "comms::option::def::SequenceLengthorcingEnabled option is not applicable to Bitfield field");
386 static_assert(!ParsedOptions::HasSequenceFixedSize,
387 "comms::option::def::SequenceFixedSize option is not applicable to Bitfield field");
388 static_assert(!ParsedOptions::HasSequenceFixedSizeUseFixedSizeStorage,
389 "comms::option::app::SequenceFixedSizeUseFixedSizeStorage option is not applicable to Bitfield field");
390 static_assert(!ParsedOptions::HasSequenceSizeFieldPrefix,
391 "comms::option::def::SequenceSizeFieldPrefix option is not applicable to Bitfield field");
392 static_assert(!ParsedOptions::HasSequenceSerLengthFieldPrefix,
393 "comms::option::def::SequenceSerLengthFieldPrefix option is not applicable to Bitfield field");
394 static_assert(!ParsedOptions::HasSequenceElemSerLengthFieldPrefix,
395 "comms::option::def::SequenceElemSerLengthFieldPrefix option is not applicable to Bitfield field");
396 static_assert(!ParsedOptions::HasSequenceElemFixedSerLengthFieldPrefix,
397 "comms::option::def::SequenceElemSerLengthFixedFieldPrefix option is not applicable to Bitfield field");
398 static_assert(!ParsedOptions::HasSequenceTrailingFieldSuffix,
399 "comms::option::def::SequenceTrailingFieldSuffix option is not applicable to Bitfield field");
400 static_assert(!ParsedOptions::HasSequenceTerminationFieldSuffix,
401 "comms::option::def::SequenceTerminationFieldSuffix option is not applicable to Bitfield field");
402 static_assert(!ParsedOptions::HasFixedSizeStorage,
403 "comms::option::app::FixedSizeStorage option is not applicable to Bitfield field");
404 static_assert(!ParsedOptions::HasCustomStorageType,
405 "comms::option::app::CustomStorageType option is not applicable to Bitfield field");
406 static_assert(!ParsedOptions::HasScalingRatio,
407 "comms::option::def::ScalingRatio option is not applicable to Bitfield field");
408 static_assert(!ParsedOptions::HasUnits,
409 "comms::option::def::Units option is not applicable to Bitfield field");
410 static_assert(!ParsedOptions::HasOrigDataView,
411 "comms::option::app::OrigDataView option is not applicable to Bitfield field");
412 static_assert(!ParsedOptions::HasMultiRangeValidation,
413 "comms::option::def::ValidNumValueRange (or similar) option is not applicable to Bitfield field");
414 static_assert(!ParsedOptions::HasVersionsRange,
415 "comms::option::def::ExistsBetweenVersions (or similar) option is not applicable to Bitfield field");
416 static_assert(!ParsedOptions::HasInvalidByDefault,
417 "comms::option::def::InvalidByDefault option is not applicable to Bitfield field");
418 static_assert(!ParsedOptions::HasMissingOnReadFail,
419 "comms::option::def::MissingOnReadFail option is not applicable to Bitfield field");
420 static_assert(!ParsedOptions::HasMissingOnInvalid,
421 "comms::option::def::MissingOnInvalid option is not applicable to Bitfield field");
422};
423
429template <typename TFieldBase, typename TMembers, typename... TOptions>
432 const Bitfield<TFieldBase, TMembers, TOptions...>& field2) noexcept
433{
434 return field1.value() == field2.value();
435}
436
442template <typename TFieldBase, typename TMembers, typename... TOptions>
445 const Bitfield<TFieldBase, TMembers, TOptions...>& field2) noexcept
446{
447 return field1.value() != field2.value();
448}
449
455template <typename TFieldBase, typename TMembers, typename... TOptions>
458 const Bitfield<TFieldBase, TMembers, TOptions...>& field2) noexcept
459{
460 return field1.value() < field2.value();
461}
462
468template <typename T>
469constexpr bool isBitfield()
470{
471 return std::is_same<typename T::CommsTag, tag::Bitfield>::value;
472}
473
477template <typename TFieldBase, typename TMembers, typename... TOptions>
478inline
479Bitfield<TFieldBase, TMembers, TOptions...>&
484
488template <typename TFieldBase, typename TMembers, typename... TOptions>
489inline
490const Bitfield<TFieldBase, TMembers, TOptions...>&
492{
493 return field;
494}
495
496} // namespace field
497
498} // namespace comms
499
500
This file contain definition of error statuses used by comms module.
Bitfield field.
Definition Bitfield.h:103
const ValueType & value() const
Get access to the stored tuple of fields.
Definition Bitfield.h:213
typename BaseImpl::Endian Endian
Endian used for serialisation.
Definition Bitfield.h:119
ErrorStatus read(TIter &iter, std::size_t size)
Read field value from input data sequence.
Definition Bitfield.h:267
static constexpr bool hasFixedValue()
Compile time inquiry of whether comms::option::def::FixedValue option has been used.
Definition Bitfield.h:188
typename BaseImpl::CommsTag CommsTag
Tag indicating type of the field.
Definition Bitfield.h:128
Bitfield()=default
Default constructor.
VersionType getVersion() const
Get version of the field.
Definition Bitfield.h:353
constexpr std::size_t length() const
Get length required to serialise the current field value.
Definition Bitfield.h:242
Bitfield(const ValueType &val)
Constructor.
Definition Bitfield.h:146
static constexpr bool hasEmptySerialization()
Compile time inquiry of whether comms::option::def::EmptySerialization option has been used.
Definition Bitfield.h:174
Bitfield< TFieldBase, TMembers, TOptions... > & toFieldBase(Bitfield< TFieldBase, TMembers, TOptions... > &field)
Upcast type of the field definition to its parent comms::field::Bitfield type in order to have access...
Definition Bitfield.h:480
bool operator==(const Bitfield< TFieldBase, TMembers, TOptions... > &field1, const Bitfield< TFieldBase, TMembers, TOptions... > &field2) noexcept
Equality comparison operator.
Definition Bitfield.h:430
void readNoStatus(TIter &iter)
Read field value from input data sequence without error check and status report.
Definition Bitfield.h:285
TFieldBase FieldBase
Base class provided in the first template parameter.
Definition Bitfield.h:116
constexpr bool isBitfield()
Compile time check function of whether a provided type is any variant of comms::field::Bitfield.
Definition Bitfield.h:469
ErrorStatus write(TIter &iter, std::size_t size) const
Write current field value to output data sequence.
Definition Bitfield.h:302
static constexpr std::size_t minLength()
Get minimal length that is required to serialise field of this type.
Definition Bitfield.h:249
Bitfield(ValueType &&val)
Constructor.
Definition Bitfield.h:153
bool refresh()
Refresh the field's contents.
Definition Bitfield.h:334
static constexpr bool hasIgnoreInvalid()
Compile time inquiry of whether comms::option::def::IgnoreInvalid option has been used.
Definition Bitfield.h:167
static constexpr bool hasFieldType()
Compile time inquiry of whether comms::option::def::FieldType option has been used.
Definition Bitfield.h:181
void writeNoStatus(TIter &iter) const
Write current field value to output data sequence without error check and status report.
Definition Bitfield.h:320
typename BaseImpl::ValueType ValueType
Value type.
Definition Bitfield.h:133
bool operator<(const Bitfield< TFieldBase, TMembers, TOptions... > &field1, const Bitfield< TFieldBase, TMembers, TOptions... > &field2) noexcept
Equivalence comparison operator.
Definition Bitfield.h:456
bool canWrite() const
Check of whether the field has a consistent value for writing.
Definition Bitfield.h:291
bool operator!=(const Bitfield< TFieldBase, TMembers, TOptions... > &field1, const Bitfield< TFieldBase, TMembers, TOptions... > &field2) noexcept
Non-equality comparison operator.
Definition Bitfield.h:443
const Bitfield< TFieldBase, TMembers, TOptions... > & toFieldBase(const Bitfield< TFieldBase, TMembers, TOptions... > &field)
Upcast type of the field definition to its parent comms::field::Bitfield type in order to have access...
Definition Bitfield.h:491
static constexpr std::size_t maxLength()
Get maximal length that is required to serialise field of this type.
Definition Bitfield.h:256
ValueType & value()
Get access to the stored tuple of fields.
Definition Bitfield.h:220
details::OptionsParser< TOptions... > ParsedOptions
All the options provided to this class bundled into struct.
Definition Bitfield.h:125
void setValue(U &&val)
Set value.
Definition Bitfield.h:235
static constexpr bool isVersionDependent()
Compile time check if this class is version dependent.
Definition Bitfield.h:340
bool setVersion(VersionType version)
Default implementation of version update.
Definition Bitfield.h:360
static constexpr bool hasFailOnInvalid()
Compile time inquiry of whether comms::option::def::FailOnInvalid option has been used.
Definition Bitfield.h:160
typename BaseImpl::VersionType VersionType
Version type.
Definition Bitfield.h:122
typename ParsedOptions::FieldType FieldType
Type of actual extending field specified via comms::option::def::FieldType.
Definition Bitfield.h:138
static constexpr bool hasWriteNoStatus()
Compile time check of whether the field has proper writeNoStatus() member function.
Definition Bitfield.h:309
const ValueType & getValue() const
Get value.
Definition Bitfield.h:227
static constexpr std::size_t memberBitLength()
Retrieve number of bits specified member field consumes.
Definition Bitfield.h:205
static constexpr bool hasNonDefaultRefresh()
Compile time check if this class has non-default refresh functionality.
Definition Bitfield.h:346
static constexpr bool hasReadNoStatus()
Compile time check of whether the field has proper readNoStatus() member function.
Definition Bitfield.h:274
static constexpr bool hasName()
Compile time inquiry of whether comms::option::def::HasName option has been used.
Definition Bitfield.h:195
bool valid() const
Check validity of the field value.
Definition Bitfield.h:326
Main namespace for all classes / functions of COMMS library.
ErrorStatus
Error statuses reported by the Communication module.
Definition ErrorStatus.h:17
constexpr unsigned version()
Version of the COMMS library as single numeric value.
Definition version.h:64
STL namespace.
Contains definition of all the options used by the COMMS library.