ADTF  3.18.2
builds/digitalwerk/solutions/adtf_content/adtf_base/adtf_core/src/libraries/a_utils/include/a_utils/core/result_util.h
Go to the documentation of this file.
1 
8 #ifndef _A_UTILS_CORE_RESULT_UTIL_H_
9 #define _A_UTILS_CORE_RESULT_UTIL_H_
10 
11 namespace A_UTILS_NS
12 {
13 
17 enum class eResultFormatFlags : tUInt32
18 {
19  RFF_DisableNone = 0x00,
20  RFF_DisableErrorCode = 0x01,
21  RFF_DisableErrorString = 0x02,
22  RFF_DisableErrorMessage = 0x04,
23  RFF_DisableFile = 0x08,
24  RFF_DisableLine = 0x10,
25  RFF_DisableFunction = 0x20
26 };//enum eResultFormatFlags
27 
37 cString to_string(const tResult& i_oResult,
38  eResultFormatFlags i_eFormatFlags = eResultFormatFlags::RFF_DisableNone,
39  const tChar* i_strFormat = nullptr);
40 
41 }//ns A_UTILS_NS
42 
43 #endif // _A_UTILS_CORE_RESULT_UTIL_H_
tChar
char tChar
The tChar defines the type for platform character set (platform and compiler dependent type).
Definition: builds/digitalwerk/solutions/adtf_content/adtf_base/adtf_core/src/libraries/a_utils/include/a_utils/base/types.h:54
tUInt32
uint32_t tUInt32
type definition for unsigned integer values (32bit) (platform and compiler independent type).
Definition: builds/digitalwerk/solutions/adtf_content/adtf_base/adtf_core/src/libraries/a_utils/include/a_utils/base/types.h:33
A_UTILS_NS::cResult
A common result class usable as return value throughout.
Definition: builds/digitalwerk/solutions/adtf_content/adtf_base/adtf_core/src/libraries/a_utils/include/a_utils/core/result.h:18
A_UTILS_NS::string_base< cStackString >
A_UTILS_NS
ADTF A_UTIL Namespace - Within adtf this is used as adtf::util or adtf_util.
Definition: d_ptr.h:11
A_UTILS_NS::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.
A_UTILS_NS::eResultFormatFlags
eResultFormatFlags
Define flags.
Definition: builds/digitalwerk/solutions/adtf_content/adtf_base/adtf_core/src/libraries/a_utils/include/a_utils/core/result_util.h:18
A_UTILS_NS::eResultFormatFlags::RFF_DisableErrorCode
@ RFF_DisableErrorCode
Do not use the string representation of the error code.
A_UTILS_NS::eResultFormatFlags::RFF_DisableFunction
@ RFF_DisableFunction
Do not use the string representation of the function.
A_UTILS_NS::eResultFormatFlags::RFF_DisableNone
@ RFF_DisableNone
Disable nothing, stringify everything.
A_UTILS_NS::eResultFormatFlags::RFF_DisableErrorString
@ RFF_DisableErrorString
Do not use the string representation of the error string.
A_UTILS_NS::eResultFormatFlags::RFF_DisableFile
@ RFF_DisableFile
Do not use the string representation of the file name.
A_UTILS_NS::eResultFormatFlags::RFF_DisableErrorMessage
@ RFF_DisableErrorMessage
Do not use the string representation of the error message.
A_UTILS_NS::eResultFormatFlags::RFF_DisableLine
@ RFF_DisableLine
Do not use the string representation of the line.