ML Reference
Public Member Functions | Protected Attributes | Friends | List of all members
ml::ErrorOutputInfos Class Reference

Struct which contains all information about errors, fatal errors, warnings, information or debug prints. More...

#include <mlErrorOutputInfos.h>

Public Member Functions

 ErrorOutputInfos ()
 Default constructor.
 
 ErrorOutputInfos (const ErrorOutputInfos &ei)
 Copy constructor.
 
ErrorOutputInfos & operator= (const ErrorOutputInfos &ei)
 Assignment operator to get identical copy.
 
MLMessageType getMessageType () const
 Returns which type of information is represented by this class.
 
MLErrorCode getErrorCode () const
 ErrorCode. If not set, ML_RESULT_OK is set.
 
const char * getLibraryPrefix () const
 Returns the prefix string to indicate the library from where the message comes (e.g., ML_ or MLAB_).
 
const char * getFunctionPrefix () const
 Returns the prefix string to be printed before the function.
 
const char * getFunctionName () const
 Returns the name of function which caused this error/debug/warning/information or tracing print.
 
const char * getReason () const
 Returns the reason why the this error/debug/warning/information or tracing print occurs.
 
const char * getHandling () const
 Returns how the routine handled the error.
 
const char * getFile () const
 Returns the name of the file which caused this error/debug/warning/information or tracing print.
 
const DateTime & getTime () const
 Returns the time stamp when message arrived.
 
int getLine () const
 Returns the line number which caused this error/debug/warning/information or tracing print.
 

Protected Attributes

MLMessageType messageType
 Which type of information is represented by this class.
 
MLErrorCode errorCode
 ErrorCode. If not set then ML_RESULT_OK is set.
 
std::string libraryPrefix
 Library prefix to indicate the library from where the message comes.
 
std::string fPrefix
 Prefix string to be printed before the function.
 
std::string functionName
 Name of function which caused this error/debug/warning/information or tracing print.
 
std::string reason
 Reason why the this error/debug/warning/information or tracing occurs.
 
std::string handling
 How the routine handled the error.
 
std::string file
 File which caused this error/debug/warning/information or tracing print.
 
DateTime time
 Time stamp when message arrived.
 
int line
 Line number which caused this error/debug/warning/information or tracing print.
 

Friends

class ErrorOutput
 Permit accesses from class ErrorOutput.
 

Detailed Description

Struct which contains all information about errors, fatal errors, warnings, information or debug prints.

Used by the ErrorOutput class. Such a struct is passed to registered callback function to inform the application about the error, warning, information or debug string. Since all stuff is inlined, this class is not exported since that would inhibit inlining.

Definition at line 52 of file mlErrorOutputInfos.h.

Constructor & Destructor Documentation

◆ ErrorOutputInfos() [1/2]

ml::ErrorOutputInfos::ErrorOutputInfos ( )
inline

Default constructor.

Definition at line 56 of file mlErrorOutputInfos.h.

References ML_PREFIX, ML_RESULT_OK, ML_WARNING, and ml::DateTime::now().

◆ ErrorOutputInfos() [2/2]

ml::ErrorOutputInfos::ErrorOutputInfos ( const ErrorOutputInfos & ei)
inline

Copy constructor.

Definition at line 71 of file mlErrorOutputInfos.h.

Member Function Documentation

◆ getErrorCode()

MLErrorCode ml::ErrorOutputInfos::getErrorCode ( ) const
inline

ErrorCode. If not set, ML_RESULT_OK is set.

Definition at line 93 of file mlErrorOutputInfos.h.

◆ getFile()

const char * ml::ErrorOutputInfos::getFile ( ) const
inline

Returns the name of the file which caused this error/debug/warning/information or tracing print.

Definition at line 111 of file mlErrorOutputInfos.h.

◆ getFunctionName()

const char * ml::ErrorOutputInfos::getFunctionName ( ) const
inline

Returns the name of function which caused this error/debug/warning/information or tracing print.

Definition at line 102 of file mlErrorOutputInfos.h.

◆ getFunctionPrefix()

const char * ml::ErrorOutputInfos::getFunctionPrefix ( ) const
inline

Returns the prefix string to be printed before the function.

Definition at line 99 of file mlErrorOutputInfos.h.

◆ getHandling()

const char * ml::ErrorOutputInfos::getHandling ( ) const
inline

Returns how the routine handled the error.

Definition at line 108 of file mlErrorOutputInfos.h.

◆ getLibraryPrefix()

const char * ml::ErrorOutputInfos::getLibraryPrefix ( ) const
inline

Returns the prefix string to indicate the library from where the message comes (e.g., ML_ or MLAB_).

Definition at line 96 of file mlErrorOutputInfos.h.

◆ getLine()

int ml::ErrorOutputInfos::getLine ( ) const
inline

Returns the line number which caused this error/debug/warning/information or tracing print.

Definition at line 117 of file mlErrorOutputInfos.h.

◆ getMessageType()

MLMessageType ml::ErrorOutputInfos::getMessageType ( ) const
inline

Returns which type of information is represented by this class.

Definition at line 90 of file mlErrorOutputInfos.h.

◆ getReason()

const char * ml::ErrorOutputInfos::getReason ( ) const
inline

Returns the reason why the this error/debug/warning/information or tracing print occurs.

Definition at line 105 of file mlErrorOutputInfos.h.

◆ getTime()

const DateTime & ml::ErrorOutputInfos::getTime ( ) const
inline

Returns the time stamp when message arrived.

Definition at line 114 of file mlErrorOutputInfos.h.

◆ operator=()

ErrorOutputInfos & ml::ErrorOutputInfos::operator= ( const ErrorOutputInfos & ei)
inline

Assignment operator to get identical copy.

Definition at line 74 of file mlErrorOutputInfos.h.

References errorCode, file, fPrefix, functionName, handling, libraryPrefix, line, messageType, reason, and time.

Friends And Related Symbol Documentation

◆ ErrorOutput

friend class ErrorOutput
friend

Permit accesses from class ErrorOutput.

Definition at line 124 of file mlErrorOutputInfos.h.

Member Data Documentation

◆ errorCode

MLErrorCode ml::ErrorOutputInfos::errorCode
protected

ErrorCode. If not set then ML_RESULT_OK is set.

Definition at line 130 of file mlErrorOutputInfos.h.

Referenced by operator=().

◆ file

std::string ml::ErrorOutputInfos::file
protected

File which caused this error/debug/warning/information or tracing print.

Definition at line 149 of file mlErrorOutputInfos.h.

Referenced by operator=().

◆ fPrefix

std::string ml::ErrorOutputInfos::fPrefix
protected

Prefix string to be printed before the function.

Definition at line 137 of file mlErrorOutputInfos.h.

Referenced by operator=().

◆ functionName

std::string ml::ErrorOutputInfos::functionName
protected

Name of function which caused this error/debug/warning/information or tracing print.

Definition at line 140 of file mlErrorOutputInfos.h.

Referenced by operator=().

◆ handling

std::string ml::ErrorOutputInfos::handling
protected

How the routine handled the error.

Definition at line 146 of file mlErrorOutputInfos.h.

Referenced by operator=().

◆ libraryPrefix

std::string ml::ErrorOutputInfos::libraryPrefix
protected

Library prefix to indicate the library from where the message comes.

Typically "ML_" or "ILAB_".

Definition at line 134 of file mlErrorOutputInfos.h.

Referenced by operator=().

◆ line

int ml::ErrorOutputInfos::line
protected

Line number which caused this error/debug/warning/information or tracing print.

Definition at line 155 of file mlErrorOutputInfos.h.

Referenced by operator=().

◆ messageType

MLMessageType ml::ErrorOutputInfos::messageType
protected

Which type of information is represented by this class.

Definition at line 127 of file mlErrorOutputInfos.h.

Referenced by operator=().

◆ reason

std::string ml::ErrorOutputInfos::reason
protected

Reason why the this error/debug/warning/information or tracing occurs.

Definition at line 143 of file mlErrorOutputInfos.h.

Referenced by operator=().

◆ time

DateTime ml::ErrorOutputInfos::time
protected

Time stamp when message arrived.

Definition at line 152 of file mlErrorOutputInfos.h.

Referenced by operator=().

The documentation for this class was generated from the following file: