ADTF A_UTIL Namespace - Within adtf this is used as adtf::util or adtf_util. More...

Namespaces
	log
	namespace for default logging functionality within A_UTILS_NS

Classes
class	d_ptr_impl
	Template to implement the Private class of the global d_pointer definitions. More...

class	d_ptr
	Template class for the d-pointer Reference class withing the Parent Class. More...

class	cDatagramSocket
	Datagram socket class. More...

class	cSocket
	Socket class. More...

class	cStreamSocket
	TCP Client socket class. More...

class	cServerSocket
	TCP Server socket class. More...

class	cBitSerializer
	Bit Serializer Class. More...

class	cDate
	Date class. More...

class	cTime
	Time class. More...

class	cDateTime
	Date and time class. More...

class	cFile
	File class. More...

class	cFilename
	File name class. More...

class	cFilepath
	File Path type. More...

class	cFileAttributes
	File attribute class. More...

class	cFileSystem
	File system class. More...

class	cMemoryBlock
	Memory block class. More...

class	cMemoryPtr

class	cMultiArrayIndex
	Multi dimensional index class used to dynamically address elements in a multi array. More...

class	cMultiArray
	Multi dimensional array class template. More...

class	cResult
	A common result class usable as return value throughout. More...

class	simple_pointer_iterator
	Simple Pointer Iterator. More...

struct	assert_out_of_range
	static string option for stack_string More...

struct	growinheap_out_of_range
	grow in heap option for stack_string More...

struct	stack_string_data_handler
	Stacked String Data Handler. More...

struct	stack_string_data_handler< growinheap_out_of_range >
	Stacked String Data Handler. More...

struct	stack_string_data_handler< assert_out_of_range >
	Stacked String Data Handler. More...

class	stack_string_data
	Stacked String Data. More...

class	stack_string_base
	Stacked String. More...

class	cStdMath
	Class for standard math operations. More...

class	string_list_base
	forward declaration More...

class	string_base
	String Class. More...

struct	string_base_compare_func
	Compare function for stl container e.g. More...

struct	string_base_no_case_compare_func
	Compare function for stl container e.g. More...

class	cStringMap
	String map class. More...

class	cStringUtil
	String Helper Class. More...

class	cTimeSynchronizer
	Time synchronization helper class for synchronizing value from an external clock to internal clock values. More...

class	cUnitConversion
	Class for unit conversions. More...

class	cVariant
	Variant class which can handle all base data types. More...

class	cVariantMap
	Type of map of strings to objects of type cVariant. More...

struct	tVersion
	POD version type. More...

class	cVersion
	Wrapper class to work with POD type tVersion. More...

class	cIndexedFile
	Base class for all indexed file classes. More...

class	IIndexedFile
	Indexed file interface. More...

class	cIndexedFileChanger
	Class for changing the extension section of indexed files. More...

class	cIndexedFileHelper
	Helper class to access file information. More...

class	cIndexedFileReader
	Class for reading indexed files. More...

class	cIndexedFileAsyncWriter
	asynchrounous file writing More...

class	cIndexedFileWriter
	Class for writing indexed files. More...

class	cIndexReadTable
	Class for storing an index table of an indexed file. More...

class	cIndexWriteTable
	Class for storing an index table of an indexed file. More...

class	cAsyncMemoryBlock
	Thread safe smart pointer for raw memory blocks. More...

class	cBase64
	Class for encode and decode with base64. More...

class	cMD5Checksum
	Class for computing MD5 sums. More...

class	cCommandLine
	Command line processing. More...

struct	xml_string_compare_func
	compare function for stl containers, e.g. More...

class	cDOMElement
	representation for an element of the cDom More...

class	cDOM
	cDOM implements a XML parser which can be used to read in XML files and perform simple (!) queries. More...

class	cFileCompression
	Class for compressing and extracting files. More...

class	cFileRingBuffer
	File-based ring buffer. More...

class	cHTMLConverter
	this class provides conversion methods between plain text strings and HTML strings More...

union	tFOURCC
	The FOURCC type is used as identifier for video compression codecs. More...

class	cIniFile
	INI file handling. More...

class	lock_free_queue
	Lock-free queue (FIFO) class that allows multiple writers and readers. More...

class	lock_free_stack
	Lock-free stack class that allows multiple writers and readers. More...

class	cLooper
	The looper helper class is a managed endless loop, which can be suspended. More...

class	cMacroResolver
	Class for resolving macros inside a string. More...

class	cParserHelper
	Parser helper. More...

class	cRegularExpression
	Regular expressions. More...

class	cStringPiece
	Class that represents string pieces. More...

struct	a_utils_enable_if
	template for SFINAE selection of the right constructor More...

struct	a_utils_enable_if< true, T >

struct	a_utils_size_of_helper
	template for handling sizeof(void) in SFINAE below (required for Visual Studio) More...

struct	a_utils_size_of_helper< tVoid >

class	cRegularExpressionArg
	Regular expression argument class. More...

class	cRegularExpressionResolver
	Class for resolving regular expression inside a filename or path. More...

class	cStatistics
	Simple statistics. More...

class	cStringTable
	String table. More...

class	cThreadLooper

class	cThreadLooperWithScheduling

class	cThreadLoop

class	cUrl
	Class for general URL representation, handling and verification against the IETF-STD66. More...

struct	tCallStack
	Respresentation for a Call stack trace. More...

class	cCPUUsage
	This helper classes can be used to determine the current CPU usage. More...

class	cDynamicLinkage
	System or platform specific functions for loading shared libraries. More...

class	cExceptionHandler
	The cExceptionHandler class provides static methods for registration and unregistration of a exception handler for unhandled exceptions. More...

class	cGUID
	The cGUID class provides static methods for generation of GUIDs. More...

class	cHighResTimer
	High resolution timer. More...

class	cHighResTimeSpan
	Class that measures timespans. More...

class	cTickCounter
	CPU Tick Counter class This class may be used for testing purposes. More...

class	cSystem
	System or platform specific functions. More...

struct	tSchedulingParameters
	Compound class, that groups scheduling parameters. More...

Typedefs
typedef int	tSocketHandle
	work with platform undependend typedefinitions for socket handlers

typedef int	tFileHandle
	The type tFileHandle is used internally only.

using	cFilenameList = std::list< cFilename >

using	cFilepathList = std::list< cFilepath >

typedef cMultiArrayIndex	cMultiArrayDimensions
	Type to specify array dimensions. More...

typedef stack_string_base< A_UTILS_DEFAULT_SIZE_OF_STRING, growinheap_out_of_range >	cStackString
	cStackString implementation for a stack string which works on stack if string is lower than A_UTILS_DEFAULT_SIZE_OF_STRING byte. More...

typedef string_base< cStackString >	cString
	cString implementation for a stack string which works on stack if string is lower than A_UTILS_DEFAULT_SIZE_OF_STRING byte. More...

typedef string_base_compare_func< cStackString, cStackString >	cStringCompareFunc
	Compare functor for the cStackString. More...

typedef string_base_no_case_compare_func< cStackString, cStackString >	cStringNoCaseCompareFunc
	Compare functor for the cStackString. More...

using	cStringList = string_list_base< cString >

typedef cDOMElement *	cDOMElementRef
	own data type for cDOMElement pointers

typedef std::list< cDOMElement >	cDOMElementList
	own data type for cDOMElement lists

typedef std::list< cDOMElement * >	cDOMElementRefList
	own data type for cDOMElement pointers lists

typedef cDOMElementList::iterator	cDOMElementItor
	iterator type for cDOMElementList

typedef cDOMElementList::const_iterator	cDOMElementItorConst
	constant iterator type for cDOMElementList

typedef cDOMElementRefList::iterator	cDOMElementRefItor
	iterator type for cDOMElementRefList

typedef cDOMElementRefList::const_iterator	cDOMElementRefItorConst
	constant iterator type for cDOMElementRefList

typedef std::map< cString, cString, xml_string_compare_func >	cDOMAttributes
	own data type for cDOM Attributes

typedef tBool(*	fnRegExpParser) (const tChar str, tInt n, tVoid dest)
	Type of regular expression parser function.

typedef std::vector< bool >	tCpuAffinityMask
	Container for a CPU Affinity mask.

Enumerations
enum class	eResultFormatFlags : tUInt32 { RFF_DisableNone = 0x00 , RFF_DisableErrorCode = 0x01 , RFF_DisableErrorString = 0x02 , RFF_DisableErrorMessage = 0x04 , RFF_DisableFile = 0x08 , RFF_DisableLine = 0x10 , RFF_DisableFunction = 0x20 }
	Define flags. More...

enum	tVariantType : tUInt8 { VT_Empty = 0 , VT_Null = 1 , VT_Bool = 2 , VT_Int8 = 3 , VT_UInt8 = 4 , VT_Int16 = 5 , VT_UInt16 = 6 , VT_Int32 = 7 , VT_UInt32 = 8 , VT_Float32 = 9 , VT_Float64 = 10 , VT_String = 11 , VT_Int64 = 12 , VT_UInt64 = 13 , VT_Array = 0x80 }
	Enumeration of variant types.

enum class	tSchedulingClass : tUInt32 { Default = 0 , Normal = 1 , RealTime = 2 }
	Enum for different scheduling schemes. More...

Functions
tBool	operator== (const cMultiArrayIndex &o_A, const cMultiArrayIndex &o_B)
	Comparison operator. More...

tBool	operator!= (const cMultiArrayIndex &o_A, const cMultiArrayIndex &o_B)
	Comparison operator. More...

template<typename T >
cString	MultiArrayToString (const cMultiArray< T > &oArray)
	Base templated function to serialize a cMultiArray into a string. More...

template<>
cString	MultiArrayToString< tInt > (const cMultiArray< tInt > &oArray)
	tInt specialization for the MultiArrayToString function More...

template<>
cString	MultiArrayToString< tFloat32 > (const cMultiArray< tFloat32 > &oArray)
	tFloat32 specialization for the MultiArrayToString function More...

template<>
cString	MultiArrayToString< tFloat64 > (const cMultiArray< tFloat64 > &oArray)
	tFloat64 specialization for the MultiArrayToString function More...

template<typename T >
tResult	ParseMultiArrayFromString (const cString &strRepr, cMultiArray< T > &arrDest)
	Base templated function to parse a cMultiArray from a string representation. More...

template<>
tResult	ParseMultiArrayFromString< tInt > (const cString &strRepr, cMultiArray< tInt > &arrDest)
	tInt specialization for the ParseMultiArrayFromString function More...

template<>
tResult	ParseMultiArrayFromString< tFloat32 > (const cString &strRepr, cMultiArray< tFloat32 > &arrDest)
	tFloat32 specialization for the ParseMultiArrayFromString function More...

template<>
tResult	ParseMultiArrayFromString< tFloat64 > (const cString &strRepr, cMultiArray< tFloat64 > &arrDest)
	tFloat64 specialization for the ParseMultiArrayFromString function More...

tBool	operator!= (const cResult &i_oLHS, const cResult &i_oRHS)
	Negated comparison operator (shallow comparison) More...

tBool	operator== (const cResult &i_oLHS, const cResult &i_oRHS)

template<tErrorCode::error_code_type ErrorCode>
tBool	operator== (const cResult &oResult, const tError< ErrorCode > &sCode)
	Comparison operator (equality) for objects of type cResult and tError. More...

template<tErrorCode::error_code_type ErrorCode>
tBool	operator!= (const cResult &oResult, const tError< ErrorCode > &sCode)
	Comparison operator (inequality) for objects of type cResult and tError. More...

template<tErrorCode::error_code_type ErrorCode>
tBool	operator== (const tError< ErrorCode > &sCode, const cResult &oResult)
	Comparison operator (equality) for objects of type cResult and tError. More...

template<tErrorCode::error_code_type ErrorCode>
tBool	operator!= (const tError< ErrorCode > &sCode, const cResult &oResult)
	Comparison operator (inequality) for objects of type cResult and tError. More...

void	swap (cResult &i_oLHS, cResult &i_oRHS)

cString	to_string (const tResult &i_oResult, eResultFormatFlags i_eFormatFlags=eResultFormatFlags::RFF_DisableNone, const tChar *i_strFormat=nullptr)
	Copy all information of an assigned result object to a (formatted) string. More...

template<typename T >
bool	operator== (const simple_pointer_iterator< T > &r1, const simple_pointer_iterator< T > &r2)
	Define equal operator between iterators.

template<typename T >
bool	operator!= (const simple_pointer_iterator< T > &r1, const simple_pointer_iterator< T > &r2)
	Define unequal operator between iterators.

template<typename T >
bool	operator< (const simple_pointer_iterator< T > &r1, const simple_pointer_iterator< T > &r2)
	Define lesser than operator between iterators.

template<typename T >
bool	operator> (const simple_pointer_iterator< T > &r1, const simple_pointer_iterator< T > &r2)
	Define greater than operator between iterators.

template<typename T >
bool	operator<= (const simple_pointer_iterator< T > &r1, const simple_pointer_iterator< T > &r2)
	Define lesser or equal to operator between iterators. More...

template<typename T >
bool	operator>= (const simple_pointer_iterator< T > &r1, const simple_pointer_iterator< T > &r2)
	Define greater or equal to operator between iterators. More...

template<typename T >
simple_pointer_iterator< T >::difference_type	operator+ (const simple_pointer_iterator< T > &r1, const simple_pointer_iterator< T > &r2)
	Define arithmetic + operation between iterators.

template<typename T >
simple_pointer_iterator< T >::difference_type	operator- (const simple_pointer_iterator< T > &r1, const simple_pointer_iterator< T > &r2)
	Define arithmetic - operation between iterators.

template<class sT >
tBool	operator== (const tChar *str1, const string_base< sT > &str2)
	String compare if equal. More...

template<class sT >
tBool	operator!= (const tChar *str1, const string_base< sT > &str2)
	String compare if not equal. More...

template<class sT >
tBool	operator< (const tChar *str1, const string_base< sT > &str2)
	String compare if less than. More...

template<class sT >
tBool	operator> (const tChar *str1, const string_base< sT > &str2)
	String compare if greater than. More...

template<class sT >
tBool	operator<= (const tChar *str1, const string_base< sT > &str2)
	String compare if less or equal than. More...

template<class sT >
tBool	operator>= (const tChar *str1, const string_base< sT > &str2)
	String compare if greater or equal than. More...

template<class sT >
tBool	operator== (const std::string &str1, const string_base< sT > &str2)
	String compare if equal. More...

template<class sT >
tBool	operator!= (const std::string &str1, const string_base< sT > &str2)
	String compare if not equal. More...

template<class sT >
tBool	operator< (const std::string &str1, const string_base< sT > &str2)
	String compare if less than. More...

template<class sT >
tBool	operator> (const std::string &str1, const string_base< sT > &str2)
	String compare if greater than. More...

template<class sT >
tBool	operator<= (const std::string &str1, const string_base< sT > &str2)
	String compare if less or equal than. More...

template<class sT >
tBool	operator>= (const std::string &str1, const string_base< sT > &str2)
	String compare if greater or equal than. More...

template<class sT >
tBool	operator== (const string_base< sT > &str1, const std::string &str2)
	String compare if equal. More...

template<class sT >
tBool	operator!= (const string_base< sT > &str1, const std::string &str2)
	String compare if not equal. More...

template<class sT >
tBool	operator< (const string_base< sT > &str1, const std::string &str2)
	String compare if less than. More...

template<class sT >
tBool	operator> (const string_base< sT > &str1, const std::string &str2)
	String compare if greater than. More...

template<class sT >
tBool	operator<= (const string_base< sT > &str1, const std::string &str2)
	String compare if less or equal than. More...

template<class sT >
tBool	operator>= (const string_base< sT > &str1, const std::string &str2)
	String compare if greater or equal than. More...

template<class sT , class sT2 >
string_base< sT >	operator+ (const string_base< sT > &str1, const string_base< sT2 > &str2)
	Join two strings. More...

template<class sT >
string_base< sT >	operator+ (const tChar *str1, const string_base< sT > &str2)
	Join two strings. More...

template<class sT >
string_base< sT >	operator+ (const string_base< sT > &str1, const tChar *str2)
	Join two strings. More...

bool	operator== (const cVariant &a, const cVariant &b)

bool	operator!= (const cVariant &a, const cVariant &b)

tBool	operator== (const cVersion &i_oLHS, const cVersion &i_oRHS)
	Compare two version type objects for equality. More...

tBool	operator!= (const cVersion &i_oLHS, const cVersion &i_oRHS)
	Compare two version type objects for inequality. More...

cString &	__strget (const tChar *strId)
	Use this function to access single elements of the global string table. More...

cString	__strfmt (const tChar *strId,...)
	Use this function to access single elements of the global string table. More...

tBool	atomic_compare_exchange (tInt32 volatile *pAddress, tInt32 nNewValue, tInt32 nExpectedValue)

template<class BasicType >
tBool	atomic_compare_exchange (volatile BasicType *pAddress, const BasicType &nNewValue, const BasicType &nExpectedValue)

tVoid	memory_barrier ()
	This method will help ensure that all memory reads and writes will have been performed before this function returns. More...

std::thread::native_handle_type	get_native_handle_of_this_thread ()
	Get the native handle for the current thread. More...

tResult	set_priority (std::thread::native_handle_type oThreadHandle, tSchedulingClass eSchedulingClass, tFloat64 fPriority)
	Sets the priority of a thread. More...

tResult	get_priority (std::thread::native_handle_type oThreadHandle, tSchedulingClass &eSchedulingClass, tFloat64 &fPriority)
	Gets the priority of a thread. More...

tResult	set_cpu_affinity (std::thread::native_handle_type oThreadHandle, const tCpuAffinityMask &oCpuAffinity)
	Sets the CPU affinity of a thread. More...

tResult	get_cpu_affinity (std::thread::native_handle_type oThreadHandle, tCpuAffinityMask &oCpuAffinity)
	Gets the CPU affinity of a thread. More...

tResult	set_scheduling (std::thread::native_handle_type oThreadHandle, const tSchedulingParameters &sScheduling)
	Sets the scheduling parameters of a thread. More...

tResult	get_scheduling (const std::thread::native_handle_type &oThreadHandle, tSchedulingParameters &sScheduling)
	Gets the scheduling parameters of a thread. More...

template<typename Callable , typename ... Args>
void	run_with_scheduling (tSchedulingParameters sScheduling, Callable &&pFunc, Args &&... args)
	Sets the given scheduling paremeters and executes the given method afterwards. More...

template<typename Callable , typename ... Args>
void	run_with_checked_scheduling (tSchedulingParameters sScheduling, Callable &&pFunc, Args &&... args)
	Sets the given scheduling paremeters and executes the given method afterwards only if the scheduling paramaters have been set successfully. More...

tResult	create_thread_with_scheduling_impl (std::thread &oThread, const tSchedulingParameters &sScheduling, std::function< void()> pFunc)
	For internal use only.

template<typename Callable , typename ... Args>
tResult	create_thread_with_scheduling (std::thread &oThread, const tSchedulingParameters &sScheduling, Callable &&pFunc, Args &&... args)
	Creates a new thread that has the given scheduling parameters. More...

template<typename Callable , typename ... Args>
std::thread	create_thread_with_scheduling (const tSchedulingParameters &sScheduling, Callable &&pFunc, Args &&... args)
	Creates a new thread that has the given scheduling parameters. More...

Variables
const tSize	MEMPTR_WRONG_SIZE_PARAM_MASK = (tSize)1 << (sizeof(tSize)*8-1)
	Memory utility class.

Detailed Description

ADTF A_UTIL Namespace - Within adtf this is used as adtf::util or adtf_util.

Typedef Documentation

◆ cMultiArrayDimensions

typedef cMultiArrayIndex cMultiArrayDimensions

Type to specify array dimensions.

You create a 2x3 array by passing a cMultiArrayDimensions(2, 3) to the cMultiArray constructor. Only difference to cMultiArrayIndex is that the index is zero-based whereas the dimension specification is done starting with 1

Definition at line 176 of file multiarray.h.

◆ cStackString

typedef stack_string_base< A_UTILS_DEFAULT_SIZE_OF_STRING, growinheap_out_of_range > cStackString

cStackString implementation for a stack string which works on stack if string is lower than A_UTILS_DEFAULT_SIZE_OF_STRING byte.

If A_UTILS_DEFAULT_SIZE_OF_STRING is reached the string is managed within heap automatically.

See also: string_base.

Definition at line 2767 of file string.h.

◆ cString

typedef string_base<cStackString> cString

cString implementation for a stack string which works on stack if string is lower than A_UTILS_DEFAULT_SIZE_OF_STRING byte.

If A_UTILS_DEFAULT_SIZE_OF_STRING is reached the string is managed within heap automatically.

See also: string_base.

Definition at line 2774 of file string.h.

◆ cStringCompareFunc

typedef string_base_compare_func<cStackString, cStackString> cStringCompareFunc

Compare functor for the cStackString.

See also: string_base.

Definition at line 2780 of file string.h.

◆ cStringNoCaseCompareFunc

typedef string_base_no_case_compare_func<cStackString, cStackString> cStringNoCaseCompareFunc

Compare functor for the cStackString.

See also: string_base.

Definition at line 2785 of file string.h.

Enumeration Type Documentation

◆ eResultFormatFlags

enum eResultFormatFlags : tUInt32

strong

Define flags.

Enumerator
RFF_DisableNone	Disable nothing, stringify everything.
RFF_DisableErrorCode	Do not use the string representation of the error code.
RFF_DisableErrorString	Do not use the string representation of the error string.
RFF_DisableErrorMessage	Do not use the string representation of the error message.
RFF_DisableFile	Do not use the string representation of the file name.
RFF_DisableLine	Do not use the string representation of the line.
RFF_DisableFunction	Do not use the string representation of the function.

Definition at line 17 of file repo/src/libraries/a_utils/include/a_utils/core/result_util.h.

◆ tSchedulingClass

enum tSchedulingClass : tUInt32

strong

Enum for different scheduling schemes.

Enumerator
Default	Choose whatever is applicable.
Normal	Basic non-realtime scheduling.
RealTime	Realtime scheduling.

Definition at line 49 of file thread_parameter.h.

Function Documentation

◆ __strfmt()

cString A_UTILS_NS::__strfmt	(	const tChar *	strId,
			...
	)

Use this function to access single elements of the global string table.

The string will be used as format string to create the output string.

Parameters

strId [in] Key value of string to be fetched.

Returns: New string

◆ __strget()

cString& A_UTILS_NS::__strget ( const tChar * strId )

Use this function to access single elements of the global string table.

Parameters

strId [in] Key value of string to be fetched.

Returns: Reference to string table element.

◆ atomic_compare_exchange()

tBool A_UTILS_NS::atomic_compare_exchange	(	volatile BasicType *	pAddress,
		const BasicType &	nNewValue,
		const BasicType &	nExpectedValue
	)

inline

Definition at line 51 of file tagged_ptr.h.

◆ create_thread_with_scheduling() [1/2]

std::thread A_UTILS_NS::create_thread_with_scheduling	(	const tSchedulingParameters &	sScheduling,
		Callable &&	pFunc,
		Args &&...	args
	)

Creates a new thread that has the given scheduling parameters.

Parameters

[in]	sScheduling	See tSchedulingParameters.
[in]	pFunc	The method to execute.
[in]	args	The arguments to the method.

Returns: The new thread object. If an error occured, joinable() will return false.

Definition at line 265 of file thread_parameter.h.

References create_thread_with_scheduling().

◆ create_thread_with_scheduling() [2/2]

tResult A_UTILS_NS::create_thread_with_scheduling	(	std::thread &	oThread,
		const tSchedulingParameters &	sScheduling,
		Callable &&	pFunc,
		Args &&...	args
	)

Creates a new thread that has the given scheduling parameters.

Parameters

[out]	oThread	The thread object.
[in]	sScheduling	See tSchedulingParameters.
[in]	pFunc	The method to execute.
[in]	args	The arguments to the method.

Returns: Standard result.

Definition at line 247 of file thread_parameter.h.

References create_thread_with_scheduling_impl().

Referenced by create_thread_with_scheduling().

◆ get_cpu_affinity()

tResult A_UTILS_NS::get_cpu_affinity	(	std::thread::native_handle_type	oThreadHandle,
		tCpuAffinityMask &	oCpuAffinity
	)

Gets the CPU affinity of a thread.

Parameters

[in]	oThreadHandle	The native thread handle.
[out]	oCpuAffinity	The CPU affinity.

Returns: Standard result.

◆ get_native_handle_of_this_thread()

std::thread::native_handle_type A_UTILS_NS::get_native_handle_of_this_thread ( )

Get the native handle for the current thread.

Returns: the native handle for the current thread.

Referenced by run_with_checked_scheduling(), and run_with_scheduling().

◆ get_priority()

tResult A_UTILS_NS::get_priority	(	std::thread::native_handle_type	oThreadHandle,
		tSchedulingClass &	eSchedulingClass,
		tFloat64 &	fPriority
	)

Gets the priority of a thread.

Parameters

[in]	oThreadHandle	The native thread handle.
[out]	eSchedulingClass	The scheduling class.
[out]	fPriority	The priority in the range [0.0, 1.0].

Returns: Standard result.

◆ get_scheduling()

tResult A_UTILS_NS::get_scheduling	(	const std::thread::native_handle_type &	oThreadHandle,
		tSchedulingParameters &	sScheduling
	)

Gets the scheduling parameters of a thread.

Parameters

[in]	oThreadHandle	The native thread handle.
[out]	sScheduling	The scheduling parameters.

Returns: Standard result.

◆ memory_barrier()

tVoid A_UTILS_NS::memory_barrier ( )

inline

This method will help ensure that all memory reads and writes will have been performed before this function returns.

It is especially useful when compiler optimzations may reorder memory access which might result in unexpected behaviour of multithreaded programs. It is similar to declaring variables 'volatile'.

Returns: void

This method is real-time safe.\nSee @ref page_real_time_safe.\n

Definition at line 70 of file tagged_ptr.h.

◆ MultiArrayToString()

cString A_UTILS_NS::MultiArrayToString ( const cMultiArray< T > & oArray )

Base templated function to serialize a cMultiArray into a string.

Parameters

oArray [in] The array to serialize

Returns: Returns the string representation of the array

Note: Base case is not implemented! Simply add a specialized version for supported types

◆ MultiArrayToString< tFloat32 >()

cString A_UTILS_NS::MultiArrayToString< tFloat32 > ( const cMultiArray< tFloat32 > & oArray )

tFloat32 specialization for the MultiArrayToString function

Parameters

oArray [in] The array to serialize

Returns: Returns the string representation of the array

◆ MultiArrayToString< tFloat64 >()

cString A_UTILS_NS::MultiArrayToString< tFloat64 > ( const cMultiArray< tFloat64 > & oArray )

tFloat64 specialization for the MultiArrayToString function

Parameters

oArray [in] The array to serialize

Returns: Returns the string representation of the array

◆ MultiArrayToString< tInt >()

cString A_UTILS_NS::MultiArrayToString< tInt > ( const cMultiArray< tInt > & oArray )

tInt specialization for the MultiArrayToString function

Parameters

oArray [in] The array to serialize

Returns: Returns the string representation of the array

◆ operator!=() [1/8]

tBool A_UTILS_NS::operator!=	(	const cMultiArrayIndex &	o_A,
		const cMultiArrayIndex &	o_B
	)

Comparison operator.

Parameters

o_A	[in] First index
o_B	[in] Second index

Returns: Returns true if a does not equal b

◆ operator!=() [2/8]

tBool operator!=	(	const cResult &	i_oLHS,
		const cResult &	i_oRHS
	)

inline

Negated comparison operator (shallow comparison)

Parameters

[in,out]	i_oLHS	Left hand side result object.
[in,out]	i_oRHS	Right hand side result object.

Returns: tTrue if both result objects do not match, tFalse otherwise.

Definition at line 374 of file repo/src/libraries/a_utils/include/a_utils/core/result.h.

◆ operator!=() [3/8]

tBool A_UTILS_NS::operator!=	(	const cResult &	oResult,
		const tError< ErrorCode > &	sCode
	)

inline

Comparison operator (inequality) for objects of type cResult and tError.

Template Parameters

ErrorCode Compile time constant error code

Parameters

[in]	oResult	Left hand side result object
[in]	sCode	Right hand side error object

Returns: tTrue if both objects contain different error codes, tFalse otherwise

Definition at line 422 of file repo/src/libraries/a_utils/include/a_utils/core/result.h.

References cResult::IsEqual().

◆ operator!=() [4/8]

tBool A_UTILS_NS::operator!=	(	const cVersion &	i_oLHS,
		const cVersion &	i_oRHS
	)

Compare two version type objects for inequality.

Parameters

[in]	i_oLHS	Left hand side version object
[in]	i_oRHS	Right hand side version object

Returns: tFalse if both version objects contain the same version information, tTrue otherwise

◆ operator!=() [5/8]

tBool A_UTILS_NS::operator!=	(	const std::string &	str1,
		const string_base< sT > &	str2
	)

String compare if not equal.

Parameters

[in]	str1	First string
[in]	str2	Second string

Returns: tTrue if strings are not equal, tFalse otherwise

Definition at line 2590 of file string.h.

References string_base< storageT >::IsNotEqual().

◆ operator!=() [6/8]

tBool A_UTILS_NS::operator!=	(	const string_base< sT > &	str1,
		const std::string &	str2
	)

String compare if not equal.

Parameters

[in]	str1	First string
[in]	str2	Second string

Returns: tTrue if strings are not equal, tFalse otherwise

Definition at line 2662 of file string.h.

References string_base< storageT >::IsNotEqual().

◆ operator!=() [7/8]

tBool A_UTILS_NS::operator!=	(	const tChar *	str1,
		const string_base< sT > &	str2
	)

String compare if not equal.

Parameters

[in]	str1	First string
[in]	str2	Second string

Returns: tTrue if strings are not equal, tFalse otherwise

Definition at line 2517 of file string.h.

References string_base< storageT >::IsNotEqual().

◆ operator!=() [8/8]

tBool A_UTILS_NS::operator!=	(	const tError< ErrorCode > &	sCode,
		const cResult &	oResult
	)

inline

Comparison operator (inequality) for objects of type cResult and tError.

Template Parameters

ErrorCode Compile time constant error code

Parameters

[in]	sCode	Left hand side error object
[in]	oResult	Right hand side result object

Returns: tTrue if both objects contain different error codes, tFalse otherwise

Definition at line 448 of file repo/src/libraries/a_utils/include/a_utils/core/result.h.

References cResult::IsEqual().

◆ operator+() [1/3]

string_base<sT> A_UTILS_NS::operator+	(	const string_base< sT > &	str1,
		const string_base< sT2 > &	str2
	)

Join two strings.

Note: Please note that the strings may only contain non-binary data!

Parameters

str1	[in] First string.
str2	[in] Second string.

Returns: The function returns the merged string.

Definition at line 2725 of file string.h.

References string_base< storageT >::Append().

◆ operator+() [2/3]

string_base<sT> A_UTILS_NS::operator+	(	const string_base< sT > &	str1,
		const tChar *	str2
	)

Join two strings.

Note: Please note that the strings may only contain non-binary data!

Parameters

str1	[in] First string.
str2	[in] Second string.

Returns: The function returns the merged string.

Definition at line 2755 of file string.h.

References string_base< storageT >::Append().

◆ operator+() [3/3]

string_base<sT> A_UTILS_NS::operator+	(	const tChar *	str1,
		const string_base< sT > &	str2
	)

Join two strings.

Note: Please note that the strings may only contain non-binary data!

Parameters

str1	[in] First string.
str2	[in] Second string.

Returns: The function returns the merged string.

Definition at line 2740 of file string.h.

References string_base< storageT >::Append().

◆ operator<() [1/3]

tBool A_UTILS_NS::operator<	(	const std::string &	str1,
		const string_base< sT > &	str2
	)

String compare if less than.

Parameters

[in]	str1	First string
[in]	str2	Second string

Returns: tTrue if str1 is less than str2, tFalse otherwise

Definition at line 2602 of file string.h.

References string_base< storageT >::Compare().

◆ operator<() [2/3]

tBool A_UTILS_NS::operator<	(	const string_base< sT > &	str1,
		const std::string &	str2
	)

String compare if less than.

Parameters

[in]	str1	First string
[in]	str2	Second string

Returns: tTrue if str1 is less than str2, tFalse otherwise

Definition at line 2674 of file string.h.

References string_base< storageT >::Compare().

◆ operator<() [3/3]

tBool A_UTILS_NS::operator<	(	const tChar *	str1,
		const string_base< sT > &	str2
	)

String compare if less than.

Parameters

[in]	str1	First string
[in]	str2	Second string

Returns: tTrue if str1 is less than str2, tFalse otherwise

Definition at line 2529 of file string.h.

References string_base< storageT >::Compare().

◆ operator<=() [1/4]

bool A_UTILS_NS::operator<=	(	const simple_pointer_iterator< T > &	r1,
		const simple_pointer_iterator< T > &	r2
	)

Define lesser or equal to operator between iterators.

Define lesser or equal operator between iterators.

Definition at line 201 of file simplepointeriterator.h.

◆ operator<=() [2/4]

tBool A_UTILS_NS::operator<=	(	const std::string &	str1,
		const string_base< sT > &	str2
	)

String compare if less or equal than.

Parameters

[in]	str1	First string
[in]	str2	Second string

Returns: tTrue if str1 is less or equal than str2, tFalse otherwise

Definition at line 2626 of file string.h.

References string_base< storageT >::Compare().

◆ operator<=() [3/4]

tBool A_UTILS_NS::operator<=	(	const string_base< sT > &	str1,
		const std::string &	str2
	)

String compare if less or equal than.

Parameters

[in]	str1	First string
[in]	str2	Second string

Returns: tTrue if str1 is less or equal than str2, tFalse otherwise

Definition at line 2698 of file string.h.

References string_base< storageT >::Compare().

◆ operator<=() [4/4]

tBool A_UTILS_NS::operator<=	(	const tChar *	str1,
		const string_base< sT > &	str2
	)

String compare if less or equal than.

Parameters

[in]	str1	First string
[in]	str2	Second string

Returns: tTrue if str1 is less or equal than str2, tFalse otherwise

Definition at line 2553 of file string.h.

References string_base< storageT >::Compare().

◆ operator==() [1/8]

tBool A_UTILS_NS::operator==	(	const cMultiArrayIndex &	o_A,
		const cMultiArrayIndex &	o_B
	)

Comparison operator.

Parameters

o_A	[in] First index
o_B	[in] Second index

Returns: Returns true if a equals b

◆ operator==() [2/8]

tBool A_UTILS_NS::operator==	(	const cResult &	i_oLHS,
		const cResult &	i_oRHS
	)

inline

Parameters

[in,out]	i_oLHS	Left hand side result object.
[in,out]	i_oRHS	Right hand side result object.

Returns: tTrue if both result objects match, tFalse otherwise.

Definition at line 369 of file repo/src/libraries/a_utils/include/a_utils/core/result.h.

◆ operator==() [3/8]

tBool A_UTILS_NS::operator==	(	const cResult &	oResult,
		const tError< ErrorCode > &	sCode
	)

inline

Comparison operator (equality) for objects of type cResult and tError.

Template Parameters

ErrorCode Compile time constant error code

Parameters

[in]	oResult	Left hand side result object
[in]	sCode	Right hand side error object

Returns: tTrue if both objects contain the same error code, tFalse otherwise

Definition at line 409 of file repo/src/libraries/a_utils/include/a_utils/core/result.h.

References cResult::IsEqual().

◆ operator==() [4/8]

tBool A_UTILS_NS::operator==	(	const cVersion &	i_oLHS,
		const cVersion &	i_oRHS
	)

Compare two version type objects for equality.

Parameters

[in]	i_oLHS	Left hand side version object
[in]	i_oRHS	Right hand side version object

Returns: tTrue if both version objects contain the same version information, tFalse otherwise

◆ operator==() [5/8]

tBool A_UTILS_NS::operator==	(	const std::string &	str1,
		const string_base< sT > &	str2
	)

String compare if equal.

Parameters

[in]	str1	First string
[in]	str2	Second string

Returns: tTrue if strings are equal, tFalse otherwise

Definition at line 2578 of file string.h.

References string_base< storageT >::IsEqual().

◆ operator==() [6/8]

tBool A_UTILS_NS::operator==	(	const string_base< sT > &	str1,
		const std::string &	str2
	)

String compare if equal.

Parameters

[in]	str1	First string
[in]	str2	Second string

Returns: tTrue if strings are equal, tFalse otherwise

Definition at line 2650 of file string.h.

References string_base< storageT >::IsEqual().

◆ operator==() [7/8]

tBool A_UTILS_NS::operator==	(	const tChar *	str1,
		const string_base< sT > &	str2
	)

String compare if equal.

Parameters

[in]	str1	First string
[in]	str2	Second string

Returns: tTrue if strings are equal, tFalse otherwise

Definition at line 2505 of file string.h.

References string_base< storageT >::IsEqual().

◆ operator==() [8/8]

tBool A_UTILS_NS::operator==	(	const tError< ErrorCode > &	sCode,
		const cResult &	oResult
	)

inline

Comparison operator (equality) for objects of type cResult and tError.

Template Parameters

ErrorCode Compile time constant error code

Parameters

[in]	sCode	Left hand side error object
[in]	oResult	Right hand side result object

Returns: tTrue if both objects contain the same error code, tFalse otherwise

Definition at line 435 of file repo/src/libraries/a_utils/include/a_utils/core/result.h.

References cResult::IsEqual().

◆ operator>() [1/3]

tBool A_UTILS_NS::operator>	(	const std::string &	str1,
		const string_base< sT > &	str2
	)

String compare if greater than.

Parameters

[in]	str1	First string
[in]	str2	Second string

Returns: tTrue if str1 is greater than str2, tFalse otherwise

Definition at line 2614 of file string.h.

References string_base< storageT >::Compare().

◆ operator>() [2/3]

tBool A_UTILS_NS::operator>	(	const string_base< sT > &	str1,
		const std::string &	str2
	)

String compare if greater than.

Parameters

[in]	str1	First string
[in]	str2	Second string

Returns: tTrue if str1 is greater than str2, tFalse otherwise

Definition at line 2686 of file string.h.

References string_base< storageT >::Compare().

◆ operator>() [3/3]

tBool A_UTILS_NS::operator>	(	const tChar *	str1,
		const string_base< sT > &	str2
	)

String compare if greater than.

Parameters

[in]	str1	First string
[in]	str2	Second string

Returns: tTrue if str1 is greater than str2, tFalse otherwise

Definition at line 2541 of file string.h.

References string_base< storageT >::Compare().

◆ operator>=() [1/4]

bool A_UTILS_NS::operator>=	(	const simple_pointer_iterator< T > &	r1,
		const simple_pointer_iterator< T > &	r2
	)

Define greater or equal to operator between iterators.

Define greater or equal operator between iterators.

Definition at line 208 of file simplepointeriterator.h.

◆ operator>=() [2/4]

tBool A_UTILS_NS::operator>=	(	const std::string &	str1,
		const string_base< sT > &	str2
	)

String compare if greater or equal than.

Parameters

[in]	str1	First string
[in]	str2	Second string

Returns: tTrue if str1 is greater or equal than str2, tFalse otherwise

Definition at line 2638 of file string.h.

References string_base< storageT >::Compare().

◆ operator>=() [3/4]

tBool A_UTILS_NS::operator>=	(	const string_base< sT > &	str1,
		const std::string &	str2
	)

String compare if greater or equal than.

Parameters

[in]	str1	First string
[in]	str2	Second string

Returns: tTrue if str1 is greater or equal than str2, tFalse otherwise

Definition at line 2710 of file string.h.

References string_base< storageT >::Compare().

◆ operator>=() [4/4]

tBool A_UTILS_NS::operator>=	(	const tChar *	str1,
		const string_base< sT > &	str2
	)

String compare if greater or equal than.

Parameters

[in]	str1	First string
[in]	str2	Second string

Returns: tTrue if str1 is greater or equal than str2, tFalse otherwise

Definition at line 2565 of file string.h.

References string_base< storageT >::Compare().

◆ ParseMultiArrayFromString()

tResult A_UTILS_NS::ParseMultiArrayFromString	(	const cString &	strRepr,
		cMultiArray< T > &	arrDest
	)

Base templated function to parse a cMultiArray from a string representation.

Parameters

strRepr	[in] The string to deserialize
arrDest	[out] Destination array

Returns: Returns standard result

Base case is not implemented! Simply add a specialized version for supported types

◆ ParseMultiArrayFromString< tFloat32 >()

tResult A_UTILS_NS::ParseMultiArrayFromString< tFloat32 >	(	const cString &	strRepr,
		cMultiArray< tFloat32 > &	arrDest
	)

tFloat32 specialization for the ParseMultiArrayFromString function

Parameters

strRepr	[in] The string to deserialize
arrDest	[out] Destination array

Returns: Returns standard result

◆ ParseMultiArrayFromString< tFloat64 >()

tResult A_UTILS_NS::ParseMultiArrayFromString< tFloat64 >	(	const cString &	strRepr,
		cMultiArray< tFloat64 > &	arrDest
	)

tFloat64 specialization for the ParseMultiArrayFromString function

Parameters

strRepr	[in] The string to deserialize
arrDest	[out] Destination array

Returns: Returns standard result

◆ ParseMultiArrayFromString< tInt >()

tResult A_UTILS_NS::ParseMultiArrayFromString< tInt >	(	const cString &	strRepr,
		cMultiArray< tInt > &	arrDest
	)

tInt specialization for the ParseMultiArrayFromString function

Parameters

strRepr	[in] The string to deserialize
arrDest	[out] Destination array

Returns: Returns standard result

◆ run_with_checked_scheduling()

void A_UTILS_NS::run_with_checked_scheduling	(	tSchedulingParameters	sScheduling,
		Callable &&	pFunc,
		Args &&...	args
	)

Sets the given scheduling paremeters and executes the given method afterwards only if the scheduling paramaters have been set successfully.

Parameters

[in]	sScheduling	The scheduling prameters.
[in]	pFunc	The method to execute.
[in]	args	The arguments to the method.

Definition at line 222 of file thread_parameter.h.

References get_native_handle_of_this_thread(), IS_OK, and set_scheduling().

◆ run_with_scheduling()

void A_UTILS_NS::run_with_scheduling	(	tSchedulingParameters	sScheduling,
		Callable &&	pFunc,
		Args &&...	args
	)

Sets the given scheduling paremeters and executes the given method afterwards.

Parameters

[in]	sScheduling	The scheduling prameters.
[in]	pFunc	The method to execute.
[in]	args	The arguments to the method.

Definition at line 208 of file thread_parameter.h.

References get_native_handle_of_this_thread(), and set_scheduling().

◆ set_cpu_affinity()

tResult A_UTILS_NS::set_cpu_affinity	(	std::thread::native_handle_type	oThreadHandle,
		const tCpuAffinityMask &	oCpuAffinity
	)

Sets the CPU affinity of a thread.

Parameters

[in]	oThreadHandle	The native thread handle.
[in]	oCpuAffinity	The requested CPU affinity.

Returns: Standard result.

◆ set_priority()

tResult A_UTILS_NS::set_priority	(	std::thread::native_handle_type	oThreadHandle,
		tSchedulingClass	eSchedulingClass,
		tFloat64	fPriority
	)

Sets the priority of a thread.

Parameters

[in]	oThreadHandle	The native thread handle.
[in]	eSchedulingClass	The scheduling class.
[in]	fPriority	The priority in the range [0.0, 1.0].

Returns: Standard result.

◆ set_scheduling()

tResult A_UTILS_NS::set_scheduling	(	std::thread::native_handle_type	oThreadHandle,
		const tSchedulingParameters &	sScheduling
	)

Sets the scheduling parameters of a thread.

Parameters

[in]	oThreadHandle	The native thread handle.
[in]	sScheduling	The scheduling parameters.

Returns: Standard result.

Referenced by run_with_checked_scheduling(), and run_with_scheduling().

◆ swap()

void A_UTILS_NS::swap	(	cResult &	i_oLHS,
		cResult &	i_oRHS
	)

inline

Parameters

[in,out]	i_oLHS	Left hand side result object.
[in,out]	i_oRHS	Right hand side result object.

Definition at line 453 of file repo/src/libraries/a_utils/include/a_utils/core/result.h.

Referenced by std::swap< A_UTILS_NS::cResult >().

◆ to_string()

cString A_UTILS_NS::to_string	(	const tResult &	i_oResult,
		eResultFormatFlags	i_eFormatFlags = `eResultFormatFlags::RFF_DisableNone`,
		const tChar *	i_strFormat = `nullptr`
	)

Copy all information of an assigned result object to a (formatted) string.

Parameters

[in]	i_oResult	The result instance getting stringified
[in]	i_eFormatFlags	Flags to disable stringification of specific information offered by tResult.
[in]	i_strFormat	Optional format specifier - if left empty, the default format is used. Currently not implemented.

Returns: String representation of all needed information from the result object

Referenced by DDEnumGenerator< EnumDataType, Enable >::addElement(), LeafCodecIndex::convertToLeafLayout(), DDToXMLFactory< DOM_NODE_TYPE >::createNode(), adtf::ucom::kiwi::current_exception_to_string(), and DDToXMLFactory< DOM_NODE_TYPE >::setOptionalAttribute().

Namespaces

Classes

Typedefs

Enumerations

Functions

Variables

Detailed Description

Typedef Documentation

◆ cMultiArrayDimensions

◆ cStackString

◆ cString

◆ cStringCompareFunc

◆ cStringNoCaseCompareFunc

Enumeration Type Documentation

◆ eResultFormatFlags

◆ tSchedulingClass

Function Documentation

◆ __strfmt()

◆ __strget()

◆ atomic_compare_exchange()

◆ create_thread_with_scheduling() [1/2]

◆ create_thread_with_scheduling() [2/2]

◆ get_cpu_affinity()

◆ get_native_handle_of_this_thread()

◆ get_priority()

◆ get_scheduling()

◆ memory_barrier()

◆ MultiArrayToString()

◆ MultiArrayToString< tFloat32 >()

◆ MultiArrayToString< tFloat64 >()

◆ MultiArrayToString< tInt >()

◆ operator!=() [1/8]

◆ operator!=() [2/8]

◆ operator!=() [3/8]

◆ operator!=() [4/8]

◆ operator!=() [5/8]

◆ operator!=() [6/8]

◆ operator!=() [7/8]

◆ operator!=() [8/8]

◆ 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/8]

◆ operator==() [2/8]

◆ operator==() [3/8]

◆ operator==() [4/8]

◆ operator==() [5/8]

◆ operator==() [6/8]

◆ operator==() [7/8]

◆ operator==() [8/8]

◆ operator>() [1/3]

◆ operator>() [2/3]

◆ operator>() [3/3]

◆ operator>=() [1/4]

◆ operator>=() [2/4]

◆ operator>=() [3/4]

◆ operator>=() [4/4]

◆ ParseMultiArrayFromString()

◆ ParseMultiArrayFromString< tFloat32 >()

◆ ParseMultiArrayFromString< tFloat64 >()

◆ ParseMultiArrayFromString< tInt >()

◆ run_with_checked_scheduling()

◆ run_with_scheduling()

◆ set_cpu_affinity()

◆ set_priority()

◆ set_scheduling()

◆ swap()

◆ to_string()