File List

Here is a list of all documented files with brief descriptions:

[detail level 12345]

▼ include
▼ comms
► details
base_detection.h
bits_access.h
detect.h
dispatch_impl.h
DispatchMsgHelperType.h
DispatchMsgIdRetrieveHelper.h
DispatchMsgLinearSwitchHelper.h
DispatchMsgPolymorphicHelper.h
DispatchMsgStaticBinSearchHelper.h
field_alias.h
FieldBase.h
FieldCastHelper.h
fields_access.h
gen_enum.h
macro_common.h
message_check.h
MessageIdTypeRetriever.h
MessageImplBases.h
MessageImplBuilder.h
MessageImplOptionsParser.h
MessageInterfaceBases.h
MessageInterfaceBuilder.h
MessageInterfaceOptionsParser.h
MsgDispatcherOptionsParser.h
MsgFactoryBase.h
MsgFactoryOptionsParser.h
process.h
protocol_layers_access.h
ReadIteratorHelper.h
reverse_macro_args.h
tag.h
transport_fields_access.h
ValueAssignWrapper.h
variant_access.h
WriteIteratorHelper.h
► field
► adapter
AvailableLength.h
CustomReadWrap.h
CustomRefreshWrap.h
CustomValidator.h
CustomWriteWrap.h
DefaultValueInitialiser.h
DisplayOffset.h
EmptySerialization.h
ExistsBetweenVersions.h
FailOnInvalid.h
FieldType.h
FixedBitLength.h
FixedLength.h
FixedValue.h
IgnoreInvalid.h
InvalidByDefault.h
MissingOnInvalid.h
MissingOnReadFail.h
NumValueMultiRangeValidator.h
RemLengthMemberField.h
SequenceElemFixedSerLengthFieldPrefix.h
SequenceElemLengthForcing.h
SequenceElemSerLengthFieldPrefix.h
SequenceFixedSize.h
SequenceLengthForcing.h
SequenceSerLengthFieldPrefix.h
SequenceSizeFieldPrefix.h
SequenceSizeForcing.h
SequenceTerminationFieldSuffix.h
SequenceTrailingFieldSuffix.h
SerOffset.h
VariantResetOnDestruct.h
VarLength.h
VersionStorage.h
► basic
ArrayList.h
Bitfield.h
Bundle.h
CommonFuncs.h
EnumValue.h
FloatValue.h
IntValue.h
Optional.h
String.h
Variant.h
► details
AdaptBasicField.h
adapters.h
FieldOpHelpers.h
MembersVersionDependency.h
OptionsParser.h
VersionStorage.h
ArrayList.h	Contains definition of comms::field::ArrayList
basics.h
Bitfield.h	Contains definition of comms::field::Bitfield
BitmaskValue.h	Contains definition of comms::field::BitmaskValue
Bundle.h	Contains definition of comms::field::Bundle
EnumValue.h	Contains definition of comms::field::EnumValue
FloatValue.h	Contains definition of comms::field::FloatValue
IntValue.h	Contains definition of comms::field::IntValue
Optional.h	Contains definition of comms::field::Optional
OptionalMode.h	Contains definition of the mode used for comms::field::Optional fields
String.h	Contains definition of comms::field::String
tag.h	Contains definition of various tag classes
Variant.h	Contains definition of comms::field::Variant
► protocol
► checksum
BasicSum.h	Contains definition of comms::protocol::checksum::BasicSum
BasicXor.h	Contains definition of comms::protocol::checksum::BasicXor
Crc.h	Contains definition of comms::protocol::checksum::Crc
► details
ChecksumLayerOptionsParser.h
MsgDataLayerOptionsParser.h
MsgIdLayerOptionsParser.h
MsgSizeLayerOptionsParser.h
ProtocolLayerBase.h
ProtocolLayerBaseOptionsParser.h
ProtocolLayerDetails.h
ProtocolLayerExtendingClassHelper.h
SyncPrefixLayerOptionsParser.h
TransportValueLayerAdapter.h
TransportValueLayerBases.h
TransportValueLayerOptionsParser.h
ChecksumLayer.h	Contains definition of comms::protocol::ChecksumLayer
ChecksumPrefixLayer.h	Contains definition of comms::protocol::ChecksumPrefixLayer
MsgDataLayer.h	Contains definition of comms::protocol::MsgDataLayer
MsgIdLayer.h	This file contains "Message ID" protocol layer of the "comms" module
MsgSizeLayer.h	Contains definition of comms::protocol::MsgSizeLayer
ProtocolLayerBase.h	Contains definition of comms::protocol::ProtocolLayerBase
SyncPrefixLayer.h	Contains definition of comms::protocol::SyncPrefixLayer
TransportValueLayer.h	Contains definition of comms::protocol::TransportValueLayer
► util
► details
AssignHelper.h
ConstructHelper.h
detect.h
type_traits.h	Replacement to some types from standard type_traits
access.h	Contains functions for raw data access / (de)serialization
AlignedStorage.h	Replacement of std::aligned_storage due to deprecation since C++23
alloc.h	This file contains various generic allocator classes that may be used to allocate objects using dynamic memory or "in-place" allocations
ArrayView.h	Contains comms::util::ArrayView class
assign.h	Provides helper assign() function to allow easy assignment of values to collections or views
BitSizeToByteSize.h
construct.h	Provides helper construct() function to allow easy construction of various collection types
detect.h	Various compile-time detection functions of whether specific member functions and/or types exist
MaxSizeOf.h
ScopeGuard.h	Contains definition of the "Scope Guard" idiom, see comms::util::ScopeGuard
SizeToType.h
StaticQueue.h	This file contains the definition and implementation of the static queue, which also can be used as circular buffer
StaticString.h	Contains comms::util::StaticString class
StaticVector.h	Contains comms::util::StaticVector class
StringView.h	Contains comms::util::StringView class
Tuple.h	Contains various tuple type manipulation classes and functions
type_traits.h	Replacement to some types from standard type_traits
Assert.h	This file contains classes required for generic custom assertion functionality
cast.h	Contains definition of various casts
comms.h	Aggregates all the includes of the COMMS library interface
CompileControl.h	Contains various compiler related definitions
dispatch.h	Contains extra logic to help with dispatching message types and objects
EmptyHandler.h	Contains definition of comms::EmptyHandler class
ErrorStatus.h	This file contain definition of error statuses used by comms module
Field.h	Contains definition of comms::Field class
field_cast.h	Contained definition of field_cast() function. Now deprecated, use "comms/cast.h" instead
fields.h	This file provides all the definitions from comms::field namespace
GenericHandler.h	This file contains definition of common handler
GenericMessage.h	Provides implementation of comms::GenericMessage class
iterator.h	Provides auxiliary functions for retrieving best type of iterator for read/write operations
Message.h	Contains definition of Message object interface and various base classes for custom messages
MessageBase.h	Provides common base class for the custom messages with default implementation
MsgDispatcher.h	Contains definition of MsgDispatcher class which facilitates dispatching of message object to appropriate handler
MsgFactory.h	Contains definition of comms::MsgFactory class
MsgFactoryCreateFailureReason.h	Contains definition of comms::MsgFactoryCreateFailureReason enum
options.h	Contains definition of all the options used by the COMMS library
process.h	Provides auxiliary functions for processing input and dispatching messages
protocols.h	This file provides all the definitions from comms::protocol namespace
traits.h	This file contains all the classes necessary to properly define message traits
units.h	This file contains all the functions required for proper units conversion
version.h	Contains version information of the library