ADTF
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
A_UTILS_NS Namespace Reference

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

Namespaces

namespace  log
 namespace for default logging functionality within A_UTILS_NS
 

Classes

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 >
 
struct  assert_out_of_range
 static string option for stack_string More...
 
class  cAsyncMemoryBlock
 Thread safe smart pointer for raw memory blocks. More...
 
class  cBase64
 Class for encode and decode with base64. More...
 
class  cBitSerializer
 Bit Serializer Class. More...
 
class  cCommandLine
 Command line processing. More...
 
class  cCPUUsage
 This helper classes can be used to determine the current CPU usage. More...
 
class  cDatagramSocket
 Datagram socket class. More...
 
class  cDate
 Date class. More...
 
class  cDateTime
 Date and time class. More...
 
class  cDOM
 cDOM implements a XML parser which can be used to read in XML files and perform simple (!) queries. More...
 
class  cDOMElement
 representation for an element of the cDom 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  cFile
 File class. More...
 
class  cFileAttributes
 File attribute class. More...
 
class  cFileCompression
 Class for compressing and extracting files. More...
 
class  cFilename
 File name class. More...
 
class  cFilepath
 File Path type. More...
 
class  cFileRingBuffer
 File-based ring buffer. More...
 
class  cFileSystem
 File system class. 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  cHTMLConverter
 this class provides conversion methods between plain text strings and HTML strings More...
 
class  cIndexedFile
 Base class for all indexed file classes. More...
 
class  cIndexedFileAsyncWriter
 asynchrounous file writing 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  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  cIniFile
 INI file handling. 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  cMD5Checksum
 Class for computing MD5 sums. More...
 
class  cMemoryBlock
 Memory block class. More...
 
class  cMemoryPtr
 
class  cMultiArray
 Multi dimensional array class template. More...
 
class  cMultiArrayIndex
 Multi dimensional index class used to dynamically address elements in a multi array. More...
 
class  cParserHelper
 Parser helper. More...
 
class  cRegularExpression
 Regular expressions. More...
 
class  cRegularExpressionArg
 Regular expression argument class. More...
 
class  cRegularExpressionResolver
 Class for resolving regular expression inside a filename or path. More...
 
class  cResult
 A common result class usable as return value throughout. More...
 
class  cServerSocket
 TCP Server socket class. More...
 
class  cSocket
 Socket class. More...
 
class  cStatistics
 Simple statistics. More...
 
class  cStdMath
 Class for standard math operations. More...
 
class  cStreamSocket
 TCP Client socket class. More...
 
class  cStringMap
 String map class. More...
 
class  cStringPiece
 Class that represents string pieces. More...
 
class  cStringTable
 String table. More...
 
class  cStringUtil
 String Helper Class. More...
 
class  cSystem
 System or platform specific functions. More...
 
class  cThreadLoop
 
class  cThreadLooper
 
class  cThreadLooperWithScheduling
 
class  cTickCounter
 CPU Tick Counter class This class may be used for testing purposes. More...
 
class  cTime
 Time 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  cUrl
 Class for general URL representation, handling and verification against the IETF-STD66. 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...
 
class  cVersion
 Wrapper class to work with POD type tVersion. More...
 
class  d_ptr
 Template class for the d-pointer Reference class withing the Parent Class. More...
 
class  d_ptr_impl
 Template to implement the Private class of the global d_pointer definitions. More...
 
struct  growinheap_out_of_range
 grow in heap option for stack_string More...
 
class  IIndexedFile
 Indexed file interface. 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  simple_pointer_iterator
 Simple Pointer Iterator. More...
 
class  stack_string_base
 Stacked String. More...
 
class  stack_string_data
 Stacked String Data. More...
 
struct  stack_string_data_handler
 Stacked String Data Handler. More...
 
struct  stack_string_data_handler< assert_out_of_range >
 Stacked String Data Handler. More...
 
struct  stack_string_data_handler< growinheap_out_of_range >
 Stacked String Data Handler. 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  string_list_base
 forward declaration More...
 
struct  tCallStack
 Respresentation for a Call stack trace. More...
 
union  tFOURCC
 The FOURCC type is used as identifier for video compression codecs. More...
 
struct  tSchedulingParameters
 Compound class, that groups scheduling parameters. More...
 
struct  tVersion
 POD version type. More...
 
struct  xml_string_compare_func
 compare function for stl containers, e.g. 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.
 
typedef stack_string_base< A_UTILS_DEFAULT_SIZE_OF_STRING, growinheap_out_of_rangecStackString
 cStackString implementation for a stack string which works on stack if string is lower than A_UTILS_DEFAULT_SIZE_OF_STRING byte.
 
typedef string_base< cStackStringcString
 cString implementation for a stack string which works on stack if string is lower than A_UTILS_DEFAULT_SIZE_OF_STRING byte.
 
typedef string_base_compare_func< cStackString, cStackStringcStringCompareFunc
 Compare functor for the cStackString.
 
typedef string_base_no_case_compare_func< cStackString, cStackStringcStringNoCaseCompareFunc
 Compare functor for the cStackString.
 
using cStringList = string_list_base<cString>
 
typedef cDOMElementcDOMElementRef
 own data type for cDOMElement pointers
 
typedef std::list< cDOMElementcDOMElementList
 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_funccDOMAttributes
 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. More...
 
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.
 
tBool operator!= (const cMultiArrayIndex &o_A, const cMultiArrayIndex &o_B)
 Comparison operator.
 
template<typename T>
cString MultiArrayToString (const cMultiArray< T > &oArray)
 Base templated function to serialize a cMultiArray into a string.
 
template<>
cString MultiArrayToString< tInt > (const cMultiArray< tInt > &oArray)
 tInt specialization for the MultiArrayToString function
 
template<>
cString MultiArrayToString< tFloat32 > (const cMultiArray< tFloat32 > &oArray)
 tFloat32 specialization for the MultiArrayToString function
 
template<>
cString MultiArrayToString< tFloat64 > (const cMultiArray< tFloat64 > &oArray)
 tFloat64 specialization for the MultiArrayToString function
 
template<typename T>
tResult ParseMultiArrayFromString (const cString &strRepr, cMultiArray< T > &arrDest)
 Base templated function to parse a cMultiArray from a string representation.
 
template<>
tResult ParseMultiArrayFromString< tInt > (const cString &strRepr, cMultiArray< tInt > &arrDest)
 tInt specialization for the ParseMultiArrayFromString function
 
template<>
tResult ParseMultiArrayFromString< tFloat32 > (const cString &strRepr, cMultiArray< tFloat32 > &arrDest)
 tFloat32 specialization for the ParseMultiArrayFromString function
 
template<>
tResult ParseMultiArrayFromString< tFloat64 > (const cString &strRepr, cMultiArray< tFloat64 > &arrDest)
 tFloat64 specialization for the ParseMultiArrayFromString function
 
tBool operator!= (const cResult &i_oLHS, const cResult &i_oRHS) noexcept
 Negated comparison operator (shallow comparison)
 
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) noexcept
 Comparison operator (equality) for objects of type cResult and tError.
 
template<tErrorCode::error_code_type ErrorCode>
tBool operator!= (const cResult &oResult, const tError< ErrorCode > &sCode) noexcept
 Comparison operator (inequality) for objects of type cResult and tError.
 
template<tErrorCode::error_code_type ErrorCode>
tBool operator== (const tError< ErrorCode > &sCode, const cResult &oResult) noexcept
 Comparison operator (equality) for objects of type cResult and tError.
 
template<tErrorCode::error_code_type ErrorCode>
tBool operator!= (const tError< ErrorCode > &sCode, const cResult &oResult) noexcept
 Comparison operator (inequality) for objects of type cResult and tError.
 
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.
 
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.
 
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.
 
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.
 
template<class sT>
tBool operator!= (const tChar *str1, const string_base< sT > &str2)
 String compare if not equal.
 
template<class sT>
tBool operator< (const tChar *str1, const string_base< sT > &str2)
 String compare if less than.
 
template<class sT>
tBool operator> (const tChar *str1, const string_base< sT > &str2)
 String compare if greater than.
 
template<class sT>
tBool operator<= (const tChar *str1, const string_base< sT > &str2)
 String compare if less or equal than.
 
template<class sT>
tBool operator>= (const tChar *str1, const string_base< sT > &str2)
 String compare if greater or equal than.
 
template<class sT>
tBool operator== (const std::string &str1, const string_base< sT > &str2)
 String compare if equal.
 
template<class sT>
tBool operator!= (const std::string &str1, const string_base< sT > &str2)
 String compare if not equal.
 
template<class sT>
tBool operator< (const std::string &str1, const string_base< sT > &str2)
 String compare if less than.
 
template<class sT>
tBool operator> (const std::string &str1, const string_base< sT > &str2)
 String compare if greater than.
 
template<class sT>
tBool operator<= (const std::string &str1, const string_base< sT > &str2)
 String compare if less or equal than.
 
template<class sT>
tBool operator>= (const std::string &str1, const string_base< sT > &str2)
 String compare if greater or equal than.
 
template<class sT>
tBool operator== (const string_base< sT > &str1, const std::string &str2)
 String compare if equal.
 
template<class sT>
tBool operator!= (const string_base< sT > &str1, const std::string &str2)
 String compare if not equal.
 
template<class sT>
tBool operator< (const string_base< sT > &str1, const std::string &str2)
 String compare if less than.
 
template<class sT>
tBool operator> (const string_base< sT > &str1, const std::string &str2)
 String compare if greater than.
 
template<class sT>
tBool operator<= (const string_base< sT > &str1, const std::string &str2)
 String compare if less or equal than.
 
template<class sT>
tBool operator>= (const string_base< sT > &str1, const std::string &str2)
 String compare if greater or equal than.
 
template<class sT, class sT2>
string_base< sT > operator+ (const string_base< sT > &str1, const string_base< sT2 > &str2)
 Join two strings.
 
template<class sT>
string_base< sT > operator+ (const tChar *str1, const string_base< sT > &str2)
 Join two strings.
 
template<class sT>
string_base< sT > operator+ (const string_base< sT > &str1, const tChar *str2)
 Join two strings.
 
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.
 
tBool operator!= (const cVersion &i_oLHS, const cVersion &i_oRHS)
 Compare two version type objects for inequality.
 
cString__strget (const tChar *strId)
 Use this function to access single elements of the global string table.
 
cString __strfmt (const tChar *strId,...)
 Use this function to access single elements of the global string table.
 
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.
 
std::thread::native_handle_type get_native_handle_of_this_thread ()
 Get the native handle for the current thread.
 
tResult set_priority (std::thread::native_handle_type oThreadHandle, tSchedulingClass eSchedulingClass, tFloat64 fPriority)
 Sets the priority of a thread.
 
tResult get_priority (std::thread::native_handle_type oThreadHandle, tSchedulingClass &eSchedulingClass, tFloat64 &fPriority)
 Gets the priority of a thread.
 
tResult set_cpu_affinity (std::thread::native_handle_type oThreadHandle, const tCpuAffinityMask &oCpuAffinity)
 Sets the CPU affinity of a thread.
 
tResult get_cpu_affinity (std::thread::native_handle_type oThreadHandle, tCpuAffinityMask &oCpuAffinity)
 Gets the CPU affinity of a thread.
 
tResult set_scheduling (std::thread::native_handle_type oThreadHandle, const tSchedulingParameters &sScheduling)
 Sets the scheduling parameters of a thread.
 
tResult get_scheduling (const std::thread::native_handle_type &oThreadHandle, tSchedulingParameters &sScheduling)
 Gets the scheduling parameters of a thread.
 
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.
 
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.
 
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.
 
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.
 

Variables

const tSize MEMPTR_WRONG_SIZE_PARAM_MASK = (tSize)1 << (sizeof(tSize)*8-1)
 Memory utility class.
 
template<typename T>
const string_base< T > string_base< T >::Empty
 
template<typename T>
const tSize string_base< T >::InvalidPos = g_npos
 

Detailed Description

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

Typedef Documentation

◆ cDOMAttributes

◆ cDOMElementItor

◆ cDOMElementItorConst

typedef cDOMElementList::const_iterator cDOMElementItorConst

◆ cDOMElementList

◆ cDOMElementRef

◆ cDOMElementRefItor

◆ cDOMElementRefItorConst

typedef cDOMElementRefList::const_iterator cDOMElementRefItorConst

◆ cDOMElementRefList

◆ cFilenameList

using cFilenameList = std::list<cFilename>

Definition at line 443 of file filename.h.

◆ cFilepathList

using cFilepathList = std::list<cFilepath>

Definition at line 444 of file filename.h.

◆ 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

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 2777 of file string.h.

◆ 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 2784 of file string.h.

◆ cStringCompareFunc

Compare functor for the cStackString.

See also
string_base.

Definition at line 2790 of file string.h.

◆ cStringList

Definition at line 728 of file stringlist.h.

◆ cStringNoCaseCompareFunc

Compare functor for the cStackString.

See also
string_base.

Definition at line 2795 of file string.h.

◆ fnRegExpParser

typedef tBool(* fnRegExpParser) (const tChar *str, tInt n, tVoid *dest)

Type of regular expression parser function.

Definition at line 379 of file regularexpression_helper.h.

◆ tCpuAffinityMask

typedef std::vector<bool> tCpuAffinityMask

Container for a CPU Affinity mask.

Definition at line 70 of file thread_parameter.h.

◆ tFileHandle

typedef int tFileHandle

The type tFileHandle is used internally only.

Definition at line 17 of file file.h.

◆ tSocketHandle

typedef int tSocketHandle

work with platform undependend typedefinitions for socket handlers

Definition at line 15 of file sockettypes.h.

Enumeration Type Documentation

◆ eResultFormatFlags

enum class 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 builds/digitalwerk/solutions/adtf_content/adtf_base/adtf_core/src/libraries/a_utils/include/a_utils/core/result_util.h.

◆ tSchedulingClass

enum class 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.

◆ tVariantType

Function Documentation

◆ __strfmt()

cString __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 & __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()

template<class BasicType>
tBool 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]

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.

Parameters
[in]sSchedulingSee tSchedulingParameters.
[in]pFuncThe method to execute.
[in]argsThe 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]

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.

Parameters
[out]oThreadThe thread object.
[in]sSchedulingSee tSchedulingParameters.
[in]pFuncThe method to execute.
[in]argsThe 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 get_cpu_affinity ( std::thread::native_handle_type oThreadHandle,
tCpuAffinityMask & oCpuAffinity )

Gets the CPU affinity of a thread.

Parameters
[in]oThreadHandleThe native thread handle.
[out]oCpuAffinityThe CPU affinity.
Returns
Standard result.

◆ get_native_handle_of_this_thread()

std::thread::native_handle_type 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 get_priority ( std::thread::native_handle_type oThreadHandle,
tSchedulingClass & eSchedulingClass,
tFloat64 & fPriority )

Gets the priority of a thread.

Parameters
[in]oThreadHandleThe native thread handle.
[out]eSchedulingClassThe scheduling class.
[out]fPriorityThe priority in the range [0.0, 1.0].
Returns
Standard result.

◆ get_scheduling()

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

Gets the scheduling parameters of a thread.

Parameters
[in]oThreadHandleThe native thread handle.
[out]sSchedulingThe scheduling parameters.
Returns
Standard result.

◆ memory_barrier()

tVoid 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()

template<typename T>
cString 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 >()

template<>
cString 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 >()

template<>
cString 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 >()

template<>
cString 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/9]

tBool 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/9]

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

Negated comparison operator (shallow comparison)

Parameters
[in,out]i_oLHSLeft hand side result object.
[in,out]i_oRHSRight hand side result object.
Returns
tTrue if both result objects do not match, tFalse otherwise.

Definition at line 496 of file builds/digitalwerk/solutions/adtf_content/adtf_base/adtf_core/src/libraries/a_utils/include/a_utils/core/result.h.

◆ operator!=() [3/9]

template<tErrorCode::error_code_type ErrorCode>
tBool operator!= ( const cResult & oResult,
const tError< ErrorCode > & sCode )
inlinenoexcept

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

Template Parameters
ErrorCodeCompile time constant error code
Parameters
[in]oResultLeft hand side result object
[in]sCodeRight hand side error object
Returns
tTrue if both objects contain different error codes, tFalse otherwise

Definition at line 544 of file builds/digitalwerk/solutions/adtf_content/adtf_base/adtf_core/src/libraries/a_utils/include/a_utils/core/result.h.

◆ operator!=() [4/9]

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

Compare two version type objects for inequality.

Parameters
[in]i_oLHSLeft hand side version object
[in]i_oRHSRight hand side version object
Returns
tFalse if both version objects contain the same version information, tTrue otherwise

◆ operator!=() [5/9]

template<typename T>
bool operator!= ( const simple_pointer_iterator< T > & r1,
const simple_pointer_iterator< T > & r2 )

Define unequal operator between iterators.

Definition at line 180 of file simplepointeriterator.h.

◆ operator!=() [6/9]

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

String compare if not equal.

Parameters
[in]str1First string
[in]str2Second string
Returns
tTrue if strings are not equal, tFalse otherwise

Definition at line 2600 of file string.h.

References string_base< storageT >::IsNotEqual().

◆ operator!=() [7/9]

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

String compare if not equal.

Parameters
[in]str1First string
[in]str2Second string
Returns
tTrue if strings are not equal, tFalse otherwise

Definition at line 2672 of file string.h.

References string_base< storageT >::IsNotEqual().

◆ operator!=() [8/9]

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

String compare if not equal.

Parameters
[in]str1First string
[in]str2Second string
Returns
tTrue if strings are not equal, tFalse otherwise

Definition at line 2527 of file string.h.

References string_base< storageT >::IsNotEqual().

◆ operator!=() [9/9]

template<tErrorCode::error_code_type ErrorCode>
tBool operator!= ( const tError< ErrorCode > & sCode,
const cResult & oResult )
inlinenoexcept

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

Template Parameters
ErrorCodeCompile time constant error code
Parameters
[in]sCodeLeft hand side error object
[in]oResultRight hand side result object
Returns
tTrue if both objects contain different error codes, tFalse otherwise

Definition at line 570 of file builds/digitalwerk/solutions/adtf_content/adtf_base/adtf_core/src/libraries/a_utils/include/a_utils/core/result.h.

◆ operator+() [1/4]

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.

Definition at line 215 of file simplepointeriterator.h.

◆ operator+() [2/4]

template<class sT, class sT2>
string_base< sT > 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 2735 of file string.h.

References string_base< storageT >::Append().

◆ operator+() [3/4]

template<class sT>
string_base< sT > 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 2765 of file string.h.

References string_base< storageT >::Append().

◆ operator+() [4/4]

template<class sT>
string_base< sT > 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 2750 of file string.h.

References string_base< storageT >::Append().

◆ operator-()

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.

Definition at line 223 of file simplepointeriterator.h.

◆ operator<() [1/4]

template<typename T>
bool operator< ( const simple_pointer_iterator< T > & r1,
const simple_pointer_iterator< T > & r2 )

Define lesser than operator between iterators.

Definition at line 187 of file simplepointeriterator.h.

◆ operator<() [2/4]

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

String compare if less than.

Parameters
[in]str1First string
[in]str2Second string
Returns
tTrue if str1 is less than str2, tFalse otherwise

Definition at line 2612 of file string.h.

References string_base< storageT >::Compare().

◆ operator<() [3/4]

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

String compare if less than.

Parameters
[in]str1First string
[in]str2Second string
Returns
tTrue if str1 is less than str2, tFalse otherwise

Definition at line 2684 of file string.h.

References string_base< storageT >::Compare().

◆ operator<() [4/4]

template<class sT>
tBool operator< ( const tChar * str1,
const string_base< sT > & str2 )

String compare if less than.

Parameters
[in]str1First string
[in]str2Second string
Returns
tTrue if str1 is less than str2, tFalse otherwise

Definition at line 2539 of file string.h.

References string_base< storageT >::Compare().

◆ operator<=() [1/4]

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.

Define lesser or equal operator between iterators.

Definition at line 201 of file simplepointeriterator.h.

◆ operator<=() [2/4]

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

String compare if less or equal than.

Parameters
[in]str1First string
[in]str2Second string
Returns
tTrue if str1 is less or equal than str2, tFalse otherwise

Definition at line 2636 of file string.h.

References string_base< storageT >::Compare().

◆ operator<=() [3/4]

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

String compare if less or equal than.

Parameters
[in]str1First string
[in]str2Second string
Returns
tTrue if str1 is less or equal than str2, tFalse otherwise

Definition at line 2708 of file string.h.

References string_base< storageT >::Compare().

◆ operator<=() [4/4]

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

String compare if less or equal than.

Parameters
[in]str1First string
[in]str2Second string
Returns
tTrue if str1 is less or equal than str2, tFalse otherwise

Definition at line 2563 of file string.h.

References string_base< storageT >::Compare().

◆ operator==() [1/9]

tBool 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/9]

tBool operator== ( const cResult & i_oLHS,
const cResult & i_oRHS )
inlinenoexcept
Parameters
[in,out]i_oLHSLeft hand side result object.
[in,out]i_oRHSRight hand side result object.
Returns
tTrue if both result objects match, tFalse otherwise.

Definition at line 491 of file builds/digitalwerk/solutions/adtf_content/adtf_base/adtf_core/src/libraries/a_utils/include/a_utils/core/result.h.

◆ operator==() [3/9]

template<tErrorCode::error_code_type ErrorCode>
tBool operator== ( const cResult & oResult,
const tError< ErrorCode > & sCode )
inlinenoexcept

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

Template Parameters
ErrorCodeCompile time constant error code
Parameters
[in]oResultLeft hand side result object
[in]sCodeRight hand side error object
Returns
tTrue if both objects contain the same error code, tFalse otherwise

Definition at line 531 of file builds/digitalwerk/solutions/adtf_content/adtf_base/adtf_core/src/libraries/a_utils/include/a_utils/core/result.h.

◆ operator==() [4/9]

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

Compare two version type objects for equality.

Parameters
[in]i_oLHSLeft hand side version object
[in]i_oRHSRight hand side version object
Returns
tTrue if both version objects contain the same version information, tFalse otherwise

◆ operator==() [5/9]

template<typename T>
bool operator== ( const simple_pointer_iterator< T > & r1,
const simple_pointer_iterator< T > & r2 )

Define equal operator between iterators.

Definition at line 173 of file simplepointeriterator.h.

◆ operator==() [6/9]

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

String compare if equal.

Parameters
[in]str1First string
[in]str2Second string
Returns
tTrue if strings are equal, tFalse otherwise

Definition at line 2588 of file string.h.

References string_base< storageT >::IsEqual().

◆ operator==() [7/9]

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

String compare if equal.

Parameters
[in]str1First string
[in]str2Second string
Returns
tTrue if strings are equal, tFalse otherwise

Definition at line 2660 of file string.h.

References string_base< storageT >::IsEqual().

◆ operator==() [8/9]

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

String compare if equal.

Parameters
[in]str1First string
[in]str2Second string
Returns
tTrue if strings are equal, tFalse otherwise

Definition at line 2515 of file string.h.

References string_base< storageT >::IsEqual().

◆ operator==() [9/9]

template<tErrorCode::error_code_type ErrorCode>
tBool operator== ( const tError< ErrorCode > & sCode,
const cResult & oResult )
inlinenoexcept

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

Template Parameters
ErrorCodeCompile time constant error code
Parameters
[in]sCodeLeft hand side error object
[in]oResultRight hand side result object
Returns
tTrue if both objects contain the same error code, tFalse otherwise

Definition at line 557 of file builds/digitalwerk/solutions/adtf_content/adtf_base/adtf_core/src/libraries/a_utils/include/a_utils/core/result.h.

◆ operator>() [1/4]

template<typename T>
bool operator> ( const simple_pointer_iterator< T > & r1,
const simple_pointer_iterator< T > & r2 )

Define greater than operator between iterators.

Definition at line 194 of file simplepointeriterator.h.

◆ operator>() [2/4]

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

String compare if greater than.

Parameters
[in]str1First string
[in]str2Second string
Returns
tTrue if str1 is greater than str2, tFalse otherwise

Definition at line 2624 of file string.h.

References string_base< storageT >::Compare().

◆ operator>() [3/4]

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

String compare if greater than.

Parameters
[in]str1First string
[in]str2Second string
Returns
tTrue if str1 is greater than str2, tFalse otherwise

Definition at line 2696 of file string.h.

References string_base< storageT >::Compare().

◆ operator>() [4/4]

template<class sT>
tBool operator> ( const tChar * str1,
const string_base< sT > & str2 )

String compare if greater than.

Parameters
[in]str1First string
[in]str2Second string
Returns
tTrue if str1 is greater than str2, tFalse otherwise

Definition at line 2551 of file string.h.

References string_base< storageT >::Compare().

◆ operator>=() [1/4]

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.

Define greater or equal operator between iterators.

Definition at line 208 of file simplepointeriterator.h.

◆ operator>=() [2/4]

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

String compare if greater or equal than.

Parameters
[in]str1First string
[in]str2Second string
Returns
tTrue if str1 is greater or equal than str2, tFalse otherwise

Definition at line 2648 of file string.h.

References string_base< storageT >::Compare().

◆ operator>=() [3/4]

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

String compare if greater or equal than.

Parameters
[in]str1First string
[in]str2Second string
Returns
tTrue if str1 is greater or equal than str2, tFalse otherwise

Definition at line 2720 of file string.h.

References string_base< storageT >::Compare().

◆ operator>=() [4/4]

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

String compare if greater or equal than.

Parameters
[in]str1First string
[in]str2Second string
Returns
tTrue if str1 is greater or equal than str2, tFalse otherwise

Definition at line 2575 of file string.h.

References string_base< storageT >::Compare().

◆ ParseMultiArrayFromString()

template<typename T>
tResult 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 >()

template<>
tResult 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 >()

template<>
tResult 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 >()

template<>
tResult 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()

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.

Parameters
[in]sSchedulingThe scheduling prameters.
[in]pFuncThe method to execute.
[in]argsThe 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()

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.

Parameters
[in]sSchedulingThe scheduling prameters.
[in]pFuncThe method to execute.
[in]argsThe 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 set_cpu_affinity ( std::thread::native_handle_type oThreadHandle,
const tCpuAffinityMask & oCpuAffinity )

Sets the CPU affinity of a thread.

Parameters
[in]oThreadHandleThe native thread handle.
[in]oCpuAffinityThe requested CPU affinity.
Returns
Standard result.

◆ set_priority()

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

Sets the priority of a thread.

Parameters
[in]oThreadHandleThe native thread handle.
[in]eSchedulingClassThe scheduling class.
[in]fPriorityThe priority in the range [0.0, 1.0].
Returns
Standard result.

◆ set_scheduling()

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

Sets the scheduling parameters of a thread.

Parameters
[in]oThreadHandleThe native thread handle.
[in]sSchedulingThe scheduling parameters.
Returns
Standard result.

Referenced by run_with_checked_scheduling(), and run_with_scheduling().

◆ swap()

void swap ( cResult & i_oLHS,
cResult & i_oRHS )
inlinenoexcept
Parameters
[in,out]i_oLHSLeft hand side result object.
[in,out]i_oRHSRight hand side result object.

Definition at line 575 of file builds/digitalwerk/solutions/adtf_content/adtf_base/adtf_core/src/libraries/a_utils/include/a_utils/core/result.h.

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

◆ to_string()

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.

Parameters
[in]i_oResultThe result instance getting stringified
[in]i_eFormatFlagsFlags to disable stringification of specific information offered by tResult.
[in]i_strFormatOptional format specifier - if left empty, the default format is used. Currently not implemented.
Returns
String representation of all needed information from the result object

References RFF_DisableNone.

Variable Documentation

◆ MEMPTR_WRONG_SIZE_PARAM_MASK

const tSize MEMPTR_WRONG_SIZE_PARAM_MASK = (tSize)1 << (sizeof(tSize)*8-1)

Memory utility class.

Definition at line 17 of file memoryptr.h.

Referenced by cMemoryPtr::Alloc(), cMemoryPtr::Attach(), and cMemoryPtr::CopyTo().

◆ string_base< T >::Empty

template<typename T>
const string_base<T> string_base< T >::Empty

Definition at line 2467 of file string.h.

◆ string_base< T >::InvalidPos

template<typename T>
const tSize string_base< T >::InvalidPos = g_npos

Definition at line 2468 of file string.h.