15#include "comms/field/basic/Optional.h"
16#include "comms/field/details/AdaptBasicField.h"
17#include "comms/field/details/OptionsParser.h"
47template <
typename TField,
typename... TOptions>
48class Optional :
public details::AdaptBasicFieldT<basic::Optional<TField>, TOptions...>
50 using BaseImpl = details::AdaptBasicFieldT<basic::Optional<TField>, TOptions...>;
53 using Endian =
typename BaseImpl::Endian;
77 using FieldType =
typename ParsedOptions::FieldType;
93 : BaseImpl(
std::move(fieldSrc))
116 return ParsedOptions::HasFailOnInvalid;
123 return ParsedOptions::HasIgnoreInvalid;
130 return ParsedOptions::HasEmptySerialization;
137 return ParsedOptions::HasFieldType;
144 return ParsedOptions::HasFixedValue;
151 return ParsedOptions::HasName;
159 return BaseImpl::getMode() == Mode::Tentative;
167 BaseImpl::setMode(Mode::Tentative);
175 return BaseImpl::getMode() == Mode::Missing;
183 BaseImpl::setMode(Mode::Missing);
191 return BaseImpl::getMode() == Mode::Exists;
199 BaseImpl::setMode(Mode::Exists);
205 return BaseImpl::field();
211 return BaseImpl::field();
217 return BaseImpl::value();
223 return BaseImpl::value();
230 return BaseImpl::getValue();
235 template <
typename U>
238 BaseImpl::setValue(std::forward<U>(val));
244 return BaseImpl::getMode();
250 BaseImpl::setMode(val);
260 return BaseImpl::length();
267 return BaseImpl::minLength();
274 return BaseImpl::maxLength();
283 return BaseImpl::valid();
293 return BaseImpl::refresh();
311 template <
typename TIter>
314 return BaseImpl::read(iter, len);
321 return BaseImpl::hasReadNoStatus();
329 template <
typename TIter>
332 BaseImpl::readNoStatus(iter);
338 return BaseImpl::canWrite();
351 template <
typename TIter>
354 return BaseImpl::write(iter, len);
361 return BaseImpl::hasWriteNoStatus();
369 template <
typename TIter>
372 BaseImpl::writeNoStatus(iter);
378 return ParsedOptions::HasCustomVersionUpdate || BaseImpl::isVersionDependent();
384 return BaseImpl::hasNonDefaultRefresh();
391 return BaseImpl::getVersion();
398 return BaseImpl::setVersion(
version);
402 using BaseImpl::readData;
403 using BaseImpl::writeData;
406 static_assert(!ParsedOptions::HasInvalidByDefault,
407 "comms::option::def::InvalidByDefault option is not applicable to Optional field");
415template <
typename TField,
typename... TOptions>
420 if (field1.getMode() != field2.getMode()) {
424 if (field1.isMissing()) {
428 return field1.field() == field2.field();
436template <
typename TField,
typename... TOptions>
441 return !(field1 == field2);
449template <
typename TField,
typename... TOptions>
454 if (field1.isMissing()) {
455 return !field2.isMissing();
458 if (field2.isMissing()) {
462 return field1.field() < field2.field();
470template <
typename TField,
typename... TOptions>
475 return (field2 < field1);
483template <
typename TField,
typename... TOptions>
488 return (field1 < field2) || (field1 == field2);
496template <
typename TField,
typename... TOptions>
501 return field2 <= field1;
512 return std::is_same<typename T::CommsTag, tag::Optional>::value;
518template <
typename TField,
typename... TOptions>
529template <
typename TField,
typename... TOptions>
This file contains classes required for generic custom assertion functionality.
This file contain definition of error statuses used by comms module.
Contains definition of the mode used for comms::field::Optional fields.
Adaptor class to any other field, that makes the field optional.
Definition Optional.h:49
bool operator<(const Optional< TField, TOptions... > &field1, const Optional< TField, TOptions... > &field2) noexcept
Equivalence comparison operator.
Definition Optional.h:450
bool operator<=(const Optional< TField, TOptions... > &field1, const Optional< TField, TOptions... > &field2) noexcept
Equivalence comparison operator.
Definition Optional.h:484
ErrorStatus read(TIter &iter, std::size_t len)
Read field value from input data sequence.
Definition Optional.h:312
Optional()=default
Default constructor.
Optional(const Field &fieldSrc)
Construct the field.
Definition Optional.h:85
bool operator>(const Optional< TField, TOptions... > &field1, const Optional< TField, TOptions... > &field2) noexcept
Equivalence comparison operator.
Definition Optional.h:471
VersionType getVersion() const
Get version of the field.
Definition Optional.h:389
constexpr bool isOptional()
Compile time check function of whether a provided type is any variant of comms::field::Optional.
Definition Optional.h:510
void setExists()
Set mode to Mode::Exists.
Definition Optional.h:197
TField Field
Type of the field.
Definition Optional.h:65
const ValueType & getValue() const
Get value.
Definition Optional.h:228
const Field & field() const
Get an access to the wrapped field object.
Definition Optional.h:209
void writeNoStatus(TIter &iter) const
Write current field value to output data sequence without error check and status report.
Definition Optional.h:370
Optional(Field &&fieldSrc)
Construct the field.
Definition Optional.h:92
bool isTentative() const
Check whether mode is equivalent to Mode::Tentative.
Definition Optional.h:157
void readNoStatus(TIter &iter)
Read field value from input data sequence without error check and status report.
Definition Optional.h:330
bool operator>=(const Optional< TField, TOptions... > &field1, const Optional< TField, TOptions... > &field2) noexcept
Equivalence comparison operator.
Definition Optional.h:497
Field & field()
Get an access to the wrapped field object.
Definition Optional.h:203
details::OptionsParser< TOptions... > ParsedOptions
All the options provided to this class bundled into struct.
Definition Optional.h:59
bool operator!=(const Optional< TField, TOptions... > &field1, const Optional< TField, TOptions... > &field2) noexcept
Non-equality comparison operator.
Definition Optional.h:437
void setMissing()
Set mode to Mode::Missing.
Definition Optional.h:181
typename BaseImpl::CommsTag CommsTag
Tag indicating type of the field.
Definition Optional.h:62
static constexpr bool hasFieldType()
Compile time inquiry of whether comms::option::def::FieldType option has been used.
Definition Optional.h:135
Optional< TField, TOptions... > & toFieldBase(Optional< TField, TOptions... > &field)
Upcast type of the field definition to its parent comms::field::Optional type in order to have access...
Definition Optional.h:521
static constexpr bool isVersionDependent()
Compile time check if this class is version dependent.
Definition Optional.h:376
static constexpr std::size_t maxLength()
Get maximal length that is required to serialise field of this type.
Definition Optional.h:272
void setValue(U &&val)
Set value.
Definition Optional.h:236
static constexpr bool hasIgnoreInvalid()
Compile time inquiry of whether comms::option::def::IgnoreInvalid option has been used.
Definition Optional.h:121
static constexpr bool hasName()
Compile time inquiry of whether comms::option::def::HasName option has been used.
Definition Optional.h:149
bool canWrite() const
Check of whether the field has a consistent value for writing.
Definition Optional.h:336
static constexpr bool hasReadNoStatus()
Compile time check of whether the field has proper readNoStatus() member function.
Definition Optional.h:319
static constexpr bool hasNonDefaultRefresh()
Compile time check if this class has non-default refresh functionality.
Definition Optional.h:382
const ValueType & value() const
Get an access to the wrapped field object.
Definition Optional.h:221
ValueType & value()
Get an access to the wrapped field object.
Definition Optional.h:215
bool doesExist() const
Check whether mode is equivalent to Mode::Exists.
Definition Optional.h:189
static constexpr bool hasFixedValue()
Compile time inquiry of whether comms::option::def::FixedValue option has been used.
Definition Optional.h:142
Mode getMode() const
Get current optional mode.
Definition Optional.h:242
Optional(const Optional &)=default
Copy constructor.
const Optional< TField, TOptions... > & toFieldBase(const Optional< TField, TOptions... > &field)
Upcast type of the field definition to its parent comms::field::Optional type in order to have access...
Definition Optional.h:532
typename BaseImpl::Endian Endian
Endian used for serialisation.
Definition Optional.h:53
std::size_t length() const
Get length required to serialise the current field value.
Definition Optional.h:258
~Optional() noexcept=default
Destructor.
void setMode(Mode val)
Get optional mode.
Definition Optional.h:248
bool operator==(const Optional< TField, TOptions... > &field1, const Optional< TField, TOptions... > &field2) noexcept
Equality comparison operator.
Definition Optional.h:416
static constexpr bool hasFailOnInvalid()
Compile time inquiry of whether comms::option::def::FailOnInvalid option has been used.
Definition Optional.h:114
bool valid() const
Check validity of the field value.
Definition Optional.h:281
bool isMissing() const
Check whether mode is equivalent to Mode::Missing.
Definition Optional.h:173
Field ValueType
Value type of this field, equal to Field.
Definition Optional.h:68
typename BaseImpl::VersionType VersionType
Version type.
Definition Optional.h:56
ErrorStatus write(TIter &iter, std::size_t len) const
Write current field value to output data sequence.
Definition Optional.h:352
bool refresh()
Refresh the field's value.
Definition Optional.h:291
static constexpr bool hasWriteNoStatus()
Compile time check of whether the field has proper writeNoStatus() member function.
Definition Optional.h:359
static constexpr std::size_t minLength()
Get minimal length that is required to serialise field of this type.
Definition Optional.h:265
static constexpr bool hasEmptySerialization()
Compile time inquiry of whether comms::option::def::EmptySerialization option has been used.
Definition Optional.h:128
bool setVersion(VersionType version)
Default implementation of version update.
Definition Optional.h:396
Optional(Optional &&)=default
Move constructor.
typename ParsedOptions::FieldType FieldType
Type of actual extending field specified via comms::option::def::FieldType.
Definition Optional.h:77
void setTentative()
Set mode to Mode::Tentative.
Definition Optional.h:165
OptionalMode
Mode to be used by comms::field::Optional.
Definition OptionalMode.h:22
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