COMMS
Template library intended to help with implementation of communication protocols.
Namespaces | Typedefs
comms::option Namespace Reference

Namespace that contains all the options used to define protocol as well as customize application specific configuration. More...

Detailed Description

Namespace that contains all the options used to define protocol as well as customize application specific configuration.

Contains all the definitions from comms::option::def and comms::option::app namespaces

Namespaces

 app
 Namespace that contains all the options used for application specific customization.
 
 def
 Namespace that contains all the options used to define protocol.
 

Typedefs

using AssumeFieldsExistence = comms::option::def::AssumeFieldsExistence
 Same as comms::option::def::AssumeFieldsExistence.
 
using BigEndian = comms::option::def::BigEndian
 Same as comms::option::def::BigEndian.
 
template<std::uintmax_t TMask, std::uintmax_t TValue = 0U>
using BitmaskReservedBits = comms::option::def::BitmaskReservedBits< TMask, TValue >
 Same as comms::option::def::BitmaskReservedBits.
 
using ChecksumLayerVerifyBeforeRead = comms::option::def::ChecksumLayerVerifyBeforeRead
 Same as comms::option::def::ChecksumLayerVerifyBeforeRead.
 
template<typename TType >
using CustomStorageType = comms::option::app::CustomStorageType< TType >
 Same as comms::option::app::CustomStorageType.
 
template<std::uintmax_t TVal>
using DefaultBigUnsignedNumValue = comms::option::def::DefaultBigUnsignedNumValue< TVal >
 Same as comms::option::def::DefaultBigUnsignedNumValue.
 
template<std::intmax_t TVal>
using DefaultNumValue = comms::option::def::DefaultNumValue< TVal >
 Same as comms::option::def::DefaultNumValue.
 
template<comms::field::OptionalMode TVal>
using DefaultOptionalMode = comms::option::def::DefaultOptionalMode< TVal >
 Same as comms::option::def::DefaultOptionalMode.
 
template<typename T >
using DefaultValueInitialiser = comms::option::def::DefaultValueInitialiser< T >
 Same as comms::option::def::DefaultValueInitialiser.
 
template<std::size_t TIdx>
using DefaultVariantIndex = comms::option::def::DefaultVariantIndex< TIdx >
 Same as comms::option::def::DefaultVariantIndex.
 
using EmptyOption = comms::option::app::EmptyOption
 Same as comms::option::app::EmptyOption.
 
using EmptySerialisation = comms::option::def::EmptySerialisation
 Same as comms::option::def::EmptySerialisation.
 
using EmptySerialization = comms::option::def::EmptySerialization
 Same as comms::option::def::EmptySerialization.
 
template<typename TEndian >
using Endian = comms::option::def::Endian< TEndian >
 Same as comms::option::def::Endian.
 
template<std::uintmax_t TFrom, std::uintmax_t TUntil>
using ExistsBetweenVersions = comms::option::def::ExistsBetweenVersions< TFrom, TUntil >
 Same as comms::option::def::ExistsBetweenVersions.
 
using ExistsByDefault = comms::option::def::ExistsByDefault
 Same as comms::option::def::ExistsByDefault.
 
template<std::uintmax_t TVer>
using ExistsSinceVersion = comms::option::def::ExistsSinceVersion< TVer >
 Same as comms::option::def::ExistsSinceVersion.
 
template<std::uintmax_t TVer>
using ExistsUntilVersion = comms::option::def::ExistsUntilVersion< TVer >
 Same as comms::option::def::ExistsUntilVersion.
 
template<typename T >
using ExtendingClass = comms::option::def::ExtendingClass< T >
 Same as comms::option::def::ExtendingClass.
 
template<typename TFields >
using ExtraTransportFields = comms::option::def::ExtraTransportFields< TFields >
 Same as comms::option::def::ExtraTransportFields.
 
template<comms::ErrorStatus TStatus = comms::ErrorStatus::InvalidMsgData>
using FailOnInvalid = comms::option::def::FailOnInvalid< TStatus >
 Same as comms::option::def::FailOnInvalid.
 
template<typename TFields >
using FieldsImpl = comms::option::def::FieldsImpl< TFields >
 Same as comms::option::def::FieldsImpl.
 
template<typename TMsg >
using FieldType = comms::option::def::FieldType< TMsg >
 Same as comms::option::def::FieldType.
 
template<std::size_t TLen, bool TSignExtend = true>
using FixedBitLength = comms::option::def::FixedBitLength< TLen, TSignExtend >
 Same as comms::option::def::FixedBitLength.
 
template<std::size_t TLen, bool TSignExtend = true>
using FixedLength = comms::option::def::FixedLength< TLen, TSignExtend >
 Same as comms::option::def::FixedLength.
 
template<std::size_t TSize>
using FixedSizeStorage = comms::option::app::FixedSizeStorage< TSize >
 Same as comms::option::app::FixedSizeStorage.
 
template<typename T >
using ForceDispatch = comms::option::app::ForceDispatch< T >
 Same as comms::option::app::ForceDispatch.
 
using ForceDispatchLinearSwitch = comms::option::app::ForceDispatchLinearSwitch
 Same as comms::option::app::ForceDispatchLinearSwitch.
 
using ForceDispatchPolymorphic = comms::option::app::ForceDispatchPolymorphic
 Same as comms::option::app::ForceDispatchPolymorphic.
 
using ForceDispatchStaticBinSearch = comms::option::app::ForceDispatchStaticBinSearch
 Same as comms::option::app::ForceDispatchStaticBinSearch.
 
template<typename T >
using Handler = comms::option::app::Handler< T >
 Same as comms::option::app::Handler.
 
using HasCustomRead = comms::option::def::HasCustomRead
 Same as comms::option::def::HasCustomRead.
 
using HasCustomRefresh = comms::option::def::HasCustomRefresh
 Same as comms::option::def::HasCustomRefresh.
 
using HasCustomVersionUpdate = comms::option::def::HasCustomVersionUpdate
 Same as comms::option::def::HasCustomVersionUpdate.
 
using HasDoGetId = comms::option::def::HasDoGetId
 Same as comms::option::def::HasDoGetId.
 
using HasDoRefresh = comms::option::def::HasDoRefresh
 Same as comms::option::def::HasDoRefresh. More...
 
using HasName = comms::option::def::HasName
 Same as comms::option::def::HasName.
 
using IdInfoInterface = comms::option::app::IdInfoInterface
 Same as comms::option::app::IdInfoInterface.
 
using IgnoreInvalid = comms::option::def::IgnoreInvalid
 Same as comms::option::def::IgnoreInvalid.
 
using InPlaceAllocation = comms::option::app::InPlaceAllocation
 Same as comms::option::app::InPlaceAllocation.
 
using InvalidByDefault = comms::option::def::InvalidByDefault
 Same as comms::option::def::InvalidByDefault.
 
using LengthInfoInterface = comms::option::app::LengthInfoInterface
 Same as comms::option::app::LengthInfoInterface.
 
using LittleEndian = comms::option::def::LittleEndian
 Same as comms::option::def::LittleEndian.
 
using MissingByDefault = comms::option::def::MissingByDefault
 Same as comms::option::def::MissingByDefault.
 
template<typename T >
using MsgIdType = comms::option::def::MsgIdType< T >
 Same as comms::option::def::MsgIdType.
 
template<typename TMsg >
using MsgType = comms::option::def::MsgType< TMsg >
 Same as comms::option::def::MsgType.
 
using NameInterface = comms::option::app::NameInterface
 Same as comms::option::app::NameInterface.
 
using NoDispatchImpl = comms::option::app::NoDispatchImpl
 Same as comms::option::app::NoDispatchImpl.
 
using NoIdImpl = comms::option::def::NoIdImpl
 Same as comms::option::def::NoIdImpl.
 
using NoLengthImpl = comms::option::app::NoLengthImpl
 Same as comms::option::app::NoLengthImpl.
 
using NoReadImpl = comms::option::app::NoReadImpl
 Same as comms::option::app::NoReadImpl.
 
using NoRefreshImpl = comms::option::app::NoRefreshImpl
 Same as comms::option::app::NoRefreshImpl.
 
using NoValidImpl = comms::option::app::NoValidImpl
 Same as comms::option::app::NoValidImpl.
 
using NoVirtualDestructor = comms::option::app::NoVirtualDestructor
 Same as comms::option::app::NoVirtualDestructor.
 
using NoWriteImpl = comms::option::app::NoWriteImpl
 Same as comms::option::app::NoWriteImpl.
 
template<std::intmax_t TOffset>
using NumValueSerOffset = comms::option::def::NumValueSerOffset< TOffset >
 Same as comms::option::def::NumValueSerOffset.
 
using OptionalExistsByDefault = comms::option::def::OptionalMissingByDefault
 Same as comms::option::def::OptionalMissingByDefault.
 
using OptionalMissingByDefault = comms::option::def::OptionalMissingByDefault
 Same as comms::option::def::OptionalMissingByDefault.
 
using OrigDataView = comms::option::app::OrigDataView
 Same as comms::option::app::OrigDataView.
 
using ProtocolLayerDisallowReadUntilDataSplit = comms::option::def::ProtocolLayerDisallowReadUntilDataSplit
 Same as comms::option::def::ProtocolLayerDisallowReadUntilDataSplit.
 
using ProtocolLayerForceReadUntilDataSplit = comms::option::def::ProtocolLayerForceReadUntilDataSplit
 Same as comms::option::def::ProtocolLayerForceReadUntilDataSplit.
 
using PseudoValue = comms::option::def::PseudoValue
 Same as comms::option::def::PseudoValue.
 
template<typename TIter >
using ReadIterator = comms::option::app::ReadIterator< TIter >
 Same as comms::option::app::ReadIterator.
 
using RefreshInterface = comms::option::app::RefreshInterface
 Same as comms::option::app::RefreshInterface.
 
template<std::size_t TIdx>
using RemLengthMemberField = comms::option::def::RemLengthMemberField< TIdx >
 Same as comms::option::def::RemLengthMemberField.
 
template<std::intmax_t TNum, std::intmax_t TDenom>
using ScalingRatio = comms::option::def::ScalingRatio< TNum, TDenom >
 Same as comms::option::def::ScalingRatio.
 
template<typename TField , comms::ErrorStatus TReadErrorStatus = comms::ErrorStatus::InvalidMsgData>
using SequenceElemFixedSerLengthFieldPrefix = comms::option::def::SequenceElemFixedSerLengthFieldPrefix< TField, TReadErrorStatus >
 Same as comms::option::def::SequenceElemFixedSerLengthFieldPrefix.
 
using SequenceElemLengthForcingEnabled = comms::option::def::SequenceElemLengthForcingEnabled
 Same as comms::option::def::SequenceElemLengthForcingEnabled.
 
template<typename TField , comms::ErrorStatus TReadErrorStatus = comms::ErrorStatus::InvalidMsgData>
using SequenceElemSerLengthFieldPrefix = comms::option::def::SequenceElemSerLengthFieldPrefix< TField, TReadErrorStatus >
 Same as comms::option::def::SequenceElemSerLengthFieldPrefix.
 
template<std::size_t TSize>
using SequenceFixedSize = comms::option::def::SequenceFixedSize< TSize >
 Same as comms::option::def::SequenceFixedSize.
 
using SequenceFixedSizeUseFixedSizeStorage = comms::option::app::SequenceFixedSizeUseFixedSizeStorage
 Same as comms::option::app::SequenceFixedSizeUseFixedSizeStorage.
 
using SequenceLengthForcingEnabled = comms::option::def::SequenceLengthForcingEnabled
 Same as comms::option::def::SequenceLengthForcingEnabled.
 
template<typename TField , comms::ErrorStatus TReadErrorStatus = comms::ErrorStatus::InvalidMsgData>
using SequenceSerLengthFieldPrefix = comms::option::def::SequenceSerLengthFieldPrefix< TField, TReadErrorStatus >
 Same as comms::option::def::SequenceSerLengthFieldPrefix.
 
template<typename TField >
using SequenceSizeFieldPrefix = comms::option::def::SequenceSizeFieldPrefix< TField >
 Same as comms::option::def::SequenceSizeFieldPrefix.
 
using SequenceSizeForcingEnabled = comms::option::def::SequenceSizeForcingEnabled
 Same as comms::option::def::SequenceSizeForcingEnabled.
 
template<typename TField >
using SequenceTerminationFieldSuffix = comms::option::def::SequenceTerminationFieldSuffix< TField >
 Same as comms::option::def::SequenceTerminationFieldSuffix.
 
template<typename TField >
using SequenceTrailingFieldSuffix = comms::option::def::SequenceTrailingFieldSuffix< TField >
 Same as comms::option::def::SequenceTrailingFieldSuffix.
 
template<std::intmax_t TId>
using StaticNumIdImpl = comms::option::def::StaticNumIdImpl< TId >
 Same as comms::option::def::StaticNumIdImpl.
 
template<typename TGenericMessage >
using SupportGenericMessage = comms::option::app::SupportGenericMessage< TGenericMessage >
 Same as comms::option::app::SupportGenericMessage.
 
template<typename TType , typename TRatio >
using Units = comms::option::def::Units< TType, TRatio >
 Same as comms::option::def::Units.
 
using UnitsAmps = comms::option::def::UnitsAmps
 Same as comms::option::def::UnitsAmps.
 
using UnitsBytes = comms::option::def::UnitsBytes
 Same as comms::option::def::UnitsBytes.
 
using UnitsCentimeters = comms::option::def::UnitsCentimeters
 Same as comms::option::def::UnitsCentimeters.
 
using UnitsCentimetersPerSecond = comms::option::def::UnitsCentimetersPerSecond
 Same as comms::option::def::UnitsCentimetersPerSecond.
 
using UnitsDays = comms::option::def::UnitsDays
 Same as comms::option::def::UnitsDays.
 
using UnitsDegrees = comms::option::def::UnitsDegrees
 Same as comms::option::def::UnitsDegrees.
 
using UnitsGigabytes = comms::option::def::UnitsGigabytes
 Same as comms::option::def::UnitsGigabytes.
 
using UnitsGigahertz = comms::option::def::UnitsGigahertz
 Same as comms::option::def::UnitsGigahertz.
 
using UnitsHertz = comms::option::def::UnitsHertz
 Same as comms::option::def::UnitsHertz.
 
using UnitsHours = comms::option::def::UnitsHours
 Same as comms::option::def::UnitsHours.
 
using UnitsKiloamps = comms::option::def::UnitsKiloamps
 Same as comms::option::def::UnitsKiloamps.
 
using UnitsKilobytes = comms::option::def::UnitsKilobytes
 Same as comms::option::def::UnitsKilobytes.
 
using UnitsKilohertz = comms::option::def::UnitsKilohertz
 Same as comms::option::def::UnitsKilohertz.
 
using UnitsKilometers = comms::option::def::UnitsKilometers
 Same as comms::option::def::UnitsKilometers.
 
using UnitsKilometersPerHour = comms::option::def::UnitsKilometersPerHour
 Same as comms::option::def::UnitsKilometersPerHour.
 
using UnitsKilometersPerSecond = comms::option::def::UnitsKilometersPerSecond
 Same as comms::option::def::UnitsKilometersPerSecond.
 
using UnitsKilovolts = comms::option::def::UnitsKilovolts
 Same as comms::option::def::UnitsKilovolts.
 
using UnitsMegabytes = comms::option::def::UnitsMegabytes
 Same as comms::option::def::UnitsMegabytes.
 
using UnitsMegahertz = comms::option::def::UnitsMegahertz
 Same as comms::option::def::UnitsMegahertz.
 
using UnitsMeters = comms::option::def::UnitsMeters
 Same as comms::option::def::UnitsMeters.
 
using UnitsMetersPerSecond = comms::option::def::UnitsMetersPerSecond
 Same as comms::option::def::UnitsMetersPerSecond.
 
using UnitsMicroamps = comms::option::def::UnitsMicroamps
 Same as comms::option::def::UnitsMicroamps.
 
using UnitsMicrometers = comms::option::def::UnitsMicrometers
 Same as comms::option::def::UnitsMicrometers.
 
using UnitsMicrometersPerSecond = comms::option::def::UnitsMicrometersPerSecond
 Same as comms::option::def::UnitsMicrometersPerSecond.
 
using UnitsMicroseconds = comms::option::def::UnitsMicroseconds
 Same as comms::option::def::UnitsMicroseconds.
 
using UnitsMicrovolts = comms::option::def::UnitsMicrovolts
 Same as comms::option::def::UnitsMicrovolts.
 
using UnitsMilliamps = comms::option::def::UnitsMilliamps
 Same as comms::option::def::UnitsMilliamps.
 
using UnitsMillimeters = comms::option::def::UnitsMillimeters
 Same as comms::option::def::UnitsMillimeters.
 
using UnitsMillimetersPerSecond = comms::option::def::UnitsMillimetersPerSecond
 Same as comms::option::def::UnitsMillimetersPerSecond.
 
using UnitsMilliseconds = comms::option::def::UnitsMilliseconds
 Same as comms::option::def::UnitsMilliseconds.
 
using UnitsMillivolts = comms::option::def::UnitsMillivolts
 Same as comms::option::def::UnitsMillivolts.
 
using UnitsMinutes = comms::option::def::UnitsMinutes
 Same as comms::option::def::UnitsMinutes.
 
using UnitsNanoamps = comms::option::def::UnitsNanoamps
 Same as comms::option::def::UnitsNanoamps.
 
using UnitsNanometers = comms::option::def::UnitsNanometers
 Same as comms::option::def::UnitsNanometers.
 
using UnitsNanometersPerSecond = comms::option::def::UnitsNanometersPerSecond
 Same as comms::option::def::UnitsNanometersPerSecond.
 
using UnitsNanoseconds = comms::option::def::UnitsNanoseconds
 Same as comms::option::def::UnitsNanoseconds.
 
using UnitsNanovolts = comms::option::def::UnitsNanovolts
 Same as comms::option::def::UnitsNanovolts.
 
using UnitsRadians = comms::option::def::UnitsRadians
 Same as comms::option::def::UnitsRadians.
 
using UnitsSeconds = comms::option::def::UnitsSeconds
 Same as comms::option::def::UnitsSeconds.
 
using UnitsTerabytes = comms::option::def::UnitsTerabytes
 Same as comms::option::def::UnitsTerabytes.
 
using UnitsVolts = comms::option::def::UnitsVolts
 Same as comms::option::def::UnitsVolts.
 
using UnitsWeeks = comms::option::def::UnitsWeeks
 Same as comms::option::def::UnitsWeeks.
 
template<std::uintmax_t TValue>
using ValidBigUnsignedNumValue = comms::option::def::ValidBigUnsignedNumValue< TValue >
 Same as comms::option::def::ValidBigUnsignedNumValue.
 
template<std::uintmax_t TValue>
using ValidBigUnsignedNumValueOverride = comms::option::def::ValidBigUnsignedNumValueOverride< TValue >
 Same as comms::option::def::ValidBigUnsignedNumValueOverride. More...
 
template<std::uintmax_t TMinValue, std::uintmax_t TMaxValue>
using ValidBigUnsignedNumValueRange = comms::option::def::ValidBigUnsignedNumValueRange< TMinValue, TMaxValue >
 Same as comms::option::def::ValidBigUnsignedNumValueRange.
 
template<std::uintmax_t TMinValue, std::uintmax_t TMaxValue>
using ValidBigUnsignedNumValueRangeOverride = comms::option::def::ValidBigUnsignedNumValueRangeOverride< TMinValue, TMaxValue >
 Same as comms::option::def::ValidBigUnsignedNumValueRangeOverride. More...
 
using ValidCheckInterface = comms::option::app::ValidCheckInterface
 Same as comms::option::app::ValidCheckInterface.
 
template<std::intmax_t TValue>
using ValidNumValue = comms::option::def::ValidNumValue< TValue >
 Same as comms::option::def::ValidNumValue.
 
template<std::intmax_t TValue>
using ValidNumValueOverride = comms::option::def::ValidNumValueOverride< TValue >
 Same as comms::option::def::ValidNumValueOverride. More...
 
template<std::intmax_t TMinValue, std::intmax_t TMaxValue>
using ValidNumValueRange = comms::option::def::ValidNumValueRange< TMinValue, TMaxValue >
 Same as comms::option::def::ValidNumValueRange.
 
template<std::intmax_t TMinValue, std::intmax_t TMaxValue>
using ValidNumValueRangeOverride = comms::option::def::ValidNumValueRangeOverride< TMinValue, TMaxValue >
 Same as comms::option::def::ValidNumValueRangeOverride. More...
 
using ValidRangesClear = comms::option::def::ValidRangesClear
 Same as comms::option::def::ValidRangesClear.
 
template<std::size_t TMin, std::size_t TMax>
using VarLength = comms::option::def::VarLength< TMin, TMax >
 Same as comms::option::def::VarLength.
 
template<std::size_t TIdx>
using VersionInExtraTransportFields = comms::option::def::VersionInExtraTransportFields< TIdx >
 Same as comms::option::def::VersionInExtraTransportFields.
 
using VersionStorage = comms::option::def::VersionStorage
 Same as comms::option::def::VersionStorage.
 
template<typename T >
using VersionType = comms::option::def::VersionType< T >
 Same as comms::option::def::VersionType.
 
template<typename TIter >
using WriteIterator = comms::option::app::WriteIterator< TIter >
 Same as comms::option::app::WriteIterator.
 
using ZeroFieldsImpl = comms::option::def::ZeroFieldsImpl
 Same as comms::option::def::ZeroFieldsImpl.
 

Typedef Documentation

◆ HasDoRefresh

◆ ValidBigUnsignedNumValueOverride

◆ ValidBigUnsignedNumValueRangeOverride

template<std::uintmax_t TMinValue, std::uintmax_t TMaxValue>
using comms::option::ValidBigUnsignedNumValueRangeOverride = typedef comms::option::def::ValidBigUnsignedNumValueRangeOverride<TMinValue, TMaxValue>

◆ ValidNumValueOverride

template<std::intmax_t TValue>
using comms::option::ValidNumValueOverride = typedef comms::option::def::ValidNumValueOverride<TValue>

◆ ValidNumValueRangeOverride

template<std::intmax_t TMinValue, std::intmax_t TMaxValue>
using comms::option::ValidNumValueRangeOverride = typedef comms::option::def::ValidNumValueRangeOverride<TMinValue, TMaxValue>