ALib C++ Library
Library Version: 2312 R0
Documentation generated by doxygen
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Nested namespaces | Classes | Enumerations | Functions
aworx::lib::results Namespace Reference

This ALib Module is very small and might undergo some changes in the future development of the library.

Please consult ALib Module Results - Programmer's Manual for further information.

Nested namespaces

 detail
 

Classes

struct  ERException
 
class  Exception
 
struct  Message
 
class  Report
 
class  ReportWriter
 
class  ReportWriterStdIO
 
class  Results
 

Enumerations

enum  Exceptions { ErrorWritingReport = 1 }
 

Functions

ALIB_WARNINGS_ALLOW_UNSAFE_BUFFER_USAGE void debugReportPlugin (const char *file, int line, const char *method, int type, const char *topic, int qtyMsgs, const nchar **msgs)
 

Enumeration Type Documentation

◆ Exceptions

enum Exceptions
strong

Exception codes of namespace ALib Results.

Enumerator
ErrorWritingReport 

Error when writing a report. This typically indicates an erroneous format string in an ALIB_ASSERT_ERROR or related macro.

Definition at line 26 of file results.hpp.

Function Documentation

◆ debugReportPlugin()

ALIB_WARNINGS_ALLOW_UNSAFE_BUFFER_USAGE void aworx::lib::results::debugReportPlugin ( const char *  file,
int  line,
const char *  method,
int  type,
const char *  topic,
int  qtyMsgs,
const nchar **  msgs 
)

This method is installed with DBG_SIMPLE_ALIB_MSG_PLUGIN in method Module::bootstrap.

The message strings are simply passed to the default Report. This way, the essential assert, error and message macros are using the ALib report system in the moment that the complete ALib library is in place (instead of only one of the library's modules.

Parameters
fileInformation about the scope of invocation.
lineInformation about the scope of invocation.
methodInformation about the scope of invocation.
typeThe type of message. See Message.
topicThe topic of message.
qtyMsgsThe number of messages in msgs.
msgsA list of strings (this is all that the essential versions of ALib reporting macros provide).

Definition at line 72 of file results.cpp.

Here is the call graph for this function: