Classes
struct	Addable
	Requires +, += from the underlying type and provides +, +=. More...

struct	Additive
	Groups Addable and Subtractable to one skill. More...

struct	Arithmetic
	Additive and Multiplicative to one skill. More...

class	BitUtil
	Bit Utility class pure static class. More...

class	ByteWordUtil
	Contains some helpful converting tools. More...

class	CharUtil
	String Utility class pure static class. More...

class	Crc
	Cyclic redundancy check (CRC) See (german): http://de.wikipedia.org/wiki/Zyklische_Redundanzpr%C3%BCfung. More...

struct	CrtpHelper
	Requires == from the underlying type and provides == and !=. More...

class	DateTimeStamp
	Class to access date and time information. More...

struct	Decrementable
	Requires –i from the underlying type and provides –i, i–. More...

class	Dequeue
	Dequeue, Queue able to pop/push elements either from front or back. More...

struct	Dividable
	Requires / from the underlying type and provides /. More...

struct	EqualityComparable
	Requires == from the underlying type and provides == and !=. More...

class	Flags
	A template to create a type safe flags type from an enum. More...

struct	GenerateBitMask
	Generates a bit mask of the given width left shifted offset bits from the least significant bit position of the word. More...

struct	GenerateUnshiftedBitMask
	Generates a bit mask of the given width whose least significant bit is at the same bit position as the least significant bit of the word. More...

struct	GenerateUnshiftedBitMask< 0 >

struct	Ignore1

struct	Ignore10

struct	Ignore2

struct	Ignore3

struct	Ignore4

struct	Ignore5

struct	Ignore6

struct	Ignore7

struct	Ignore8

struct	Ignore9

struct	Incrementable
	Requires ++i from the underlying type and provides ++i, i++. More...

struct	KeyWriteOnlyPolicy
	A write-only mutability policy to enable writing registers like new reset register. More...

struct	LessThanComparable
	Requires < from the underlying type and provides <, >, <=, >=. More...

class	LinkedList
	linked list More...

struct	ListNode
	Node used for LinkedList class. More...

struct	ListNode< T, LinkedListType::DOUBLE >
	Node used for LinkedList class. More...

struct	ListNode< T, LinkedListType::SINGLE >
	Node used for LinkedList class. More...

class	MD5
	This class provides the MD5 checksum calculation routines. More...

struct	Multipliable
	Requires * from the underlying type and provides *. More...

struct	Multiplicative
	Groups Multipliable and Dividable to one skill. More...

class	Optional
	Port of the std::optional type. More...

class	PoolAllocator
	fixed size pool allocator More...

class	Range
	A range of values limited by an lower and upper value that is included in the range. More...

struct	ReadOnlyPolicy
	A read-only mutability policy for use with Register template. More...

struct	ReadWritePolicy
	A read-write mutability policy for use with Register template. More...

struct	Register
	Template to define register at runtime, by providing the mutability policy, like Read Only/Write Only/Read Write etc, address, offset and width. More...

class	RingBuffer
	This template class implements a FIFO ringbuffer. More...

class	Span
	This template class provides a small wrapper around a data buffer. More...

class	StrongTypedef
	Prevent bugs at compile time by providing strongly-typed and expressive interfaces with zero overhead. More...

struct	Subtractable
	Requires -, -= from the underlying type and provides -, -=. More...

struct	TotallyOrdered
	Provides ==, !=, <, >, <=, >=. More...

struct	UnitStepable
	Groups imt::base::core::util::Incrementable and imt::base::core::util::Decrementable to one skill. More...

class	VersionInfo
	Provides version information in simple class. More...

class	WaitFreeRingBuffer
	This template class implements a FIFO ringbuffer to transfer data from a producer thread to a consumer thread. More...

struct	WriteOnlyPolicy
	A write-only mutability policy for use with Register template. More...

Typedefs
using	cIteratorType = CIteratorType
	for backward compatiblity ATTENTION: the only thing that is not compatible any more is: using imt::base::core::util::cIteratorType::CIteratorType

template<typename Node , CIteratorType type = CIteratorType::UNIDIRECTIONAL>
using	LinkedListConstIterator = typename LinkedList< Node const >::Iterator
	depreacted class LinkedListConstIterator --> use LinkedList::Iterator instead

using	iteratorType = IteratorType
	for backward compatiblity ATTENTION: the only thing that is not compatible any more is: using imt::base::core::util::iteratorType::IteratorType

template<typename Node , IteratorType type = IteratorType::UNIDIRECTIONAL>
using	LinkedListIterator = typename LinkedList< Node >::Iterator
	Depreacted class LinkedListConstIterator --> use LinkedList::Iterator instead.

template<typename T >
using	ObjectPoolAllocator = PoolAllocator< T >
	Depreacted class ObjectPoolAllocator --> use PoolAllocator instead.

template<typename T >
using	TrivialPoolAllocator = PoolAllocator< T >
	Depreacted class TrivialPoolAllocator --> use PoolAllocator instead.

Enumerations
enum class	LinkedListType : uint8_t { SINGLE , DOUBLE }
	Enum for the linked list types. More...

enum class	CIteratorType : uint8_t { UNIDIRECTIONAL , BIDIRECTIONAL }
	Depreacted class cIteratorType --> use IteratorType instead. More...

enum class	IteratorType : uint8_t { UNIDIRECTIONAL , BIDIRECTIONAL }
	Enum for the deprecated linked list types. More...

Functions
bool	operator== (DateTimeStamp const left, DateTimeStamp const right) noexcept
	Equals operator overload.

bool	operator!= (DateTimeStamp const left, DateTimeStamp const right) noexcept
	Not equals operator overload.

bool	operator> (DateTimeStamp const left, DateTimeStamp const right) noexcept
	Greater than operator overload.

bool	operator< (DateTimeStamp const left, DateTimeStamp const right) noexcept
	Less than operator overload.

bool	operator>= (DateTimeStamp const left, DateTimeStamp const right) noexcept
	Greater than or equal operator overload.

bool	operator<= (DateTimeStamp const left, DateTimeStamp const right) noexcept
	Less than or equal operator overload.

template<typename EnumType , typename LimitsType , typename BaseType >
bool	operator== (Flags< EnumType, LimitsType, BaseType > const &left, Flags< EnumType, LimitsType, BaseType > const &right) noexcept
	Compare for equality operator.

template<typename EnumType , typename LimitsType , typename BaseType >
bool	operator!= (Flags< EnumType, LimitsType, BaseType > const &left, Flags< EnumType, LimitsType, BaseType > const &right) noexcept
	Compare for equality operator.

template<typename ElementType >
bool	operator== (Optional< ElementType > const left, Optional< ElementType > const right) noexcept
	Compare for equality operator.

template<typename ElementType >
bool	operator!= (Optional< ElementType > const left, Optional< ElementType > const right) noexcept
	Compare for inequality operator.

template<typename ElementType >
bool	operator> (Optional< ElementType > const left, Optional< ElementType > const right) noexcept
	Greather than operator.

template<typename ElementType >
bool	operator< (Optional< ElementType > const left, Optional< ElementType > const right) noexcept
	Less than operator.

template<typename ElementType >
bool	operator<= (Optional< ElementType > const left, Optional< ElementType > const right) noexcept
	Less or equal than operator.

template<typename ElementType >
bool	operator>= (Optional< ElementType > const left, Optional< ElementType > const right) noexcept
	Greater equal than operator.

bool	operator== (VersionInfo const &left, VersionInfo const &right) noexcept
	Provide the equality operator.

bool	operator!= (VersionInfo const &left, VersionInfo const &right) noexcept
	Provide the inequality operator.

bool	operator<= (VersionInfo const &left, VersionInfo const &right) noexcept
	Provide the <= operator.

bool	operator>= (VersionInfo const &left, VersionInfo const &right) noexcept
	Provide the >= operator.

bool	operator> (VersionInfo const &left, VersionInfo const &right) noexcept
	Provide the > operator.

bool	operator< (VersionInfo const &left, VersionInfo const &right) noexcept
	Provide the < operator.

Typedef Documentation

◆ cIteratorType

using imt::base::core::util::cIteratorType = typedef CIteratorType

for backward compatiblity ATTENTION: the only thing that is not compatible any more is: using imt::base::core::util::cIteratorType::CIteratorType

workaround: using imt::base::core::util::CIteratorType

or use the new API from LinkedList

Definition at line 64 of file LinkedListConstIterator.h.

◆ iteratorType

using imt::base::core::util::iteratorType = typedef IteratorType

for backward compatiblity ATTENTION: the only thing that is not compatible any more is: using imt::base::core::util::iteratorType::IteratorType

workaround: using imt::base::core::util::IteratorType

or use the new API from LinkedList

Definition at line 67 of file LinkedListIterator.h.

◆ LinkedListConstIterator

template<typename Node , CIteratorType type = CIteratorType::UNIDIRECTIONAL>

using imt::base::core::util::LinkedListConstIterator = typedef typename LinkedList<Node const>::Iterator

depreacted class LinkedListConstIterator --> use LinkedList::Iterator instead

Definition at line 70 of file LinkedListConstIterator.h.

◆ LinkedListIterator

template<typename Node , IteratorType type = IteratorType::UNIDIRECTIONAL>

using imt::base::core::util::LinkedListIterator = typedef typename LinkedList<Node>::Iterator

Depreacted class LinkedListConstIterator --> use LinkedList::Iterator instead.

Definition at line 74 of file LinkedListIterator.h.

◆ ObjectPoolAllocator

template<typename T >

using imt::base::core::util::ObjectPoolAllocator = typedef PoolAllocator<T>

Depreacted class ObjectPoolAllocator --> use PoolAllocator instead.

Definition at line 51 of file ObjectPoolAllocator.h.

◆ TrivialPoolAllocator

template<typename T >

using imt::base::core::util::TrivialPoolAllocator = typedef PoolAllocator<T>

Depreacted class TrivialPoolAllocator --> use PoolAllocator instead.

Definition at line 51 of file TrivialPoolAllocator.h.

Enumeration Type Documentation

◆ CIteratorType

enum class imt::base::core::util::CIteratorType : uint8_t

strong

Depreacted class cIteratorType --> use IteratorType instead.

Enumerator

UNIDIRECTIONAL

BIDIRECTIONAL

use this enumerator to use the UNIDIRECTIONAL iterator implementation

use this enumerator to use the BIDIRECTIONAL iterator implementation

Definition at line 50 of file LinkedListConstIterator.h.

◆ IteratorType

enum class imt::base::core::util::IteratorType : uint8_t

strong

Enum for the deprecated linked list types.

Enumerator

UNIDIRECTIONAL

BIDIRECTIONAL

use this enumerator to use the UNIDIRECTIONAL iterator implementation

use this enumerator to use the BIDIRECTIONAL iterator implementation

Definition at line 52 of file LinkedListIterator.h.

◆ LinkedListType

enum class imt::base::core::util::LinkedListType : uint8_t

strong

Enum for the linked list types.

Enumerator

SINGLE

DOUBLE

use this enumerator to use the single linked list implementation

use this enumerator to use the double linked list implementation

Definition at line 52 of file LinkedList.h.

Function Documentation

◆ operator!=() [1/4]

bool imt::base::core::util::operator!=	(	DateTimeStamp const	left,
		DateTimeStamp const	right
	)

noexcept

Not equals operator overload.

Parameters

left	DateTime to compare.
right	DateTime to compare with.

Returns: True if instances are not equal.

◆ operator!=() [2/4]

template<typename EnumType , typename LimitsType , typename BaseType >

bool imt::base::core::util::operator!=	(	Flags< EnumType, LimitsType, BaseType > const &	left,
		Flags< EnumType, LimitsType, BaseType > const &	right
	)

noexcept

Compare for equality operator.

Will return true if at least one flags is not the same in both instances.

Parameters

other Other flags to compare with.

Returns: True if flags are not equal.

Definition at line 223 of file Flags.h.

◆ operator!=() [3/4]

template<typename ElementType >

bool imt::base::core::util::operator!=	(	Optional< ElementType > const	left,
		Optional< ElementType > const	right
	)

noexcept

Compare for inequality operator.

Parameters

other Other value to compare with.

Returns: True if values are not equal.

Definition at line 132 of file Optional.h.

◆ operator!=() [4/4]

bool imt::base::core::util::operator!=	(	VersionInfo const &	left,
		VersionInfo const &	right
	)

noexcept

Provide the inequality operator.

Parameters

left	VersionInfo to compare.
right	VersionInfo to compare with.

Returns: True if other VersionInfo is not equal to this.

◆ operator<() [1/3]

bool imt::base::core::util::operator<	(	DateTimeStamp const	left,
		DateTimeStamp const	right
	)

noexcept

Less than operator overload.

Parameters

left	DateTime to compare.
right	DateTime to compare with.

Returns: True if this instance is before the other instance.

◆ operator<() [2/3]

template<typename ElementType >

bool imt::base::core::util::operator<	(	Optional< ElementType > const	left,
		Optional< ElementType > const	right
	)

noexcept

Less than operator.

Parameters

other Other flags to compare with.

Returns: True if right value is greater.

Definition at line 158 of file Optional.h.

◆ operator<() [3/3]

bool imt::base::core::util::operator<	(	VersionInfo const &	left,
		VersionInfo const &	right
	)

noexcept

Provide the < operator.

Parameters

left	VersionInfo to compare.
right	VersionInfo to compare with.

Returns: True if this VersionInfo is lower than the other.

◆ operator<=() [1/3]

bool imt::base::core::util::operator<=	(	DateTimeStamp const	left,
		DateTimeStamp const	right
	)

noexcept

Less than or equal operator overload.

Parameters

left	DateTime to compare.
right	DateTime to compare with.

Returns: True if this instance is before or equal.

◆ operator<=() [2/3]

template<typename ElementType >

bool imt::base::core::util::operator<=	(	Optional< ElementType > const	left,
		Optional< ElementType > const	right
	)

noexcept

Less or equal than operator.

Parameters

other Other flags to compare with.

Returns: True if left value is equal or greater.

Definition at line 174 of file Optional.h.

◆ operator<=() [3/3]

bool imt::base::core::util::operator<=	(	VersionInfo const &	left,
		VersionInfo const &	right
	)

noexcept

Provide the <= operator.

Parameters

left	VersionInfo to compare.
right	VersionInfo to compare with.

Returns: True if this VersionInfo is lower or equal to the other.

◆ operator==() [1/4]

bool imt::base::core::util::operator==	(	DateTimeStamp const	left,
		DateTimeStamp const	right
	)

noexcept

Equals operator overload.

Parameters

left	DateTime to compare.
right	DateTime to compare with.

Returns: True if instances are equal.

◆ operator==() [2/4]

template<typename EnumType , typename LimitsType , typename BaseType >

bool imt::base::core::util::operator==	(	Flags< EnumType, LimitsType, BaseType > const &	left,
		Flags< EnumType, LimitsType, BaseType > const &	right
	)

noexcept

Compare for equality operator.

Will return true if exactly the same flags are set in both instances.

Parameters

other Other flags to compare with.

Returns: True if flags are equal.

Definition at line 212 of file Flags.h.

◆ operator==() [3/4]

template<typename ElementType >

bool imt::base::core::util::operator==	(	Optional< ElementType > const	left,
		Optional< ElementType > const	right
	)

noexcept

Compare for equality operator.

Parameters

other Other value to compare with.

Returns: True if values are equal.

Definition at line 116 of file Optional.h.

◆ operator==() [4/4]

bool imt::base::core::util::operator==	(	VersionInfo const &	left,
		VersionInfo const &	right
	)

noexcept

Provide the equality operator.

Parameters

left	VersionInfo to compare.
right	VersionInfo to compare with.

Returns: True if other VersionInfo is equal to this.

◆ operator>() [1/3]

bool imt::base::core::util::operator>	(	DateTimeStamp const	left,
		DateTimeStamp const	right
	)

noexcept

Greater than operator overload.

Parameters

left	DateTime to compare.
right	DateTime to compare with.

Returns: True if this instance is after the other instance.

◆ operator>() [2/3]

template<typename ElementType >

bool imt::base::core::util::operator>	(	Optional< ElementType > const	left,
		Optional< ElementType > const	right
	)

noexcept

Greather than operator.

Parameters

other Other flags to compare with.

Returns: True if left value is greater.

Definition at line 142 of file Optional.h.

◆ operator>() [3/3]

bool imt::base::core::util::operator>	(	VersionInfo const &	left,
		VersionInfo const &	right
	)

noexcept

Provide the > operator.

Parameters

left	VersionInfo to compare.
right	VersionInfo to compare with.

Returns: True if this VersionInfo is higher than the other.

◆ operator>=() [1/3]

bool imt::base::core::util::operator>=	(	DateTimeStamp const	left,
		DateTimeStamp const	right
	)

noexcept

Greater than or equal operator overload.

Parameters

left	DateTime to compare.
right	DateTime to compare with.

Returns: True if this instance is after or equal.

◆ operator>=() [2/3]

template<typename ElementType >

bool imt::base::core::util::operator>=	(	Optional< ElementType > const	left,
		Optional< ElementType > const	right
	)

noexcept

Greater equal than operator.

Parameters

other Other flags to compare with.

Returns: True if right value is equal or greater.

Definition at line 187 of file Optional.h.

◆ operator>=() [3/3]

bool imt::base::core::util::operator>=	(	VersionInfo const &	left,
		VersionInfo const &	right
	)

noexcept

Provide the >= operator.

Parameters

left	VersionInfo to compare.
right	VersionInfo to compare with.

Returns: True if this VersionInfo is higher or equal to the other.

Classes

Typedefs

Enumerations

Functions

Typedef Documentation

◆ cIteratorType

◆ iteratorType

◆ LinkedListConstIterator

◆ LinkedListIterator

◆ ObjectPoolAllocator

◆ TrivialPoolAllocator

Enumeration Type Documentation

◆ CIteratorType

◆ IteratorType

◆ LinkedListType

Function Documentation

◆ operator!=() [1/4]

◆ operator!=() [2/4]

◆ operator!=() [3/4]

◆ operator!=() [4/4]

◆ operator<() [1/3]

◆ operator<() [2/3]

◆ operator<() [3/3]

◆ operator<=() [1/3]

◆ operator<=() [2/3]

◆ operator<=() [3/3]

◆ operator==() [1/4]

◆ operator==() [2/4]

◆ operator==() [3/4]

◆ operator==() [4/4]

◆ operator>() [1/3]

◆ operator>() [2/3]

◆ operator>() [3/3]

◆ operator>=() [1/3]

◆ operator>=() [2/3]

◆ operator>=() [3/3]