mlErrorOutputInfos.h

Go to the documentation of this file.

/*************************************************************************************
**
** Copyright 2007, MeVis Medical Solutions AG
**
** The user may use this file in accordance with the license agreement provided with
** the Software or, alternatively, in accordance with the terms contained in a
** written agreement between the user and MeVis Medical Solutions AG.
**
** For further information use the contact form at https://www.mevislab.de/contact
**
**************************************************************************************/
 
#ifndef ML_ERROR_OUTPUT_INFOS_H
#define ML_ERROR_OUTPUT_INFOS_H
 
 
#include "mlDateTime.h"
#include "mlErrorMacros.h"
#include "mlErrorOutput.h"
#include "mlUtilsSystem.h"
 
ML_UTILS_START_NAMESPACE
 
//---------------------------------------------------------------------------------------------
//---------------------------------------------------------------------------------------------
class ErrorOutputInfos {
public:
 
  inline ErrorOutputInfos()
  {
    messageType   = ML_WARNING;
    errorCode     = ML_RESULT_OK;
    libraryPrefix = ML_PREFIX;
    fPrefix       = "";
    functionName  = "";
    reason        = "";
    handling      = "";
    file          = "";
    time          = DateTime().now();
    line          = 0;
  }
 
  inline ErrorOutputInfos(const ErrorOutputInfos &ei)     {  *this = ei; }
 
  inline ErrorOutputInfos &operator=(const ErrorOutputInfos &ei)
  {
    messageType   = ei.messageType;
    errorCode     = ei.errorCode;
    libraryPrefix = ei.libraryPrefix;
    fPrefix       = ei.fPrefix;
    functionName  = ei.functionName;
    reason        = ei.reason;
    handling      = ei.handling;
    file          = ei.file;
    time          = ei.time;
    line          = ei.line;
    return *this;
  }
 
  inline MLMessageType   getMessageType()   const { return messageType;           }
 
  inline MLErrorCode     getErrorCode()     const { return errorCode;             }
 
  inline const char*     getLibraryPrefix() const { return libraryPrefix.c_str(); }
 
  inline const char*     getFunctionPrefix() const { return fPrefix.c_str();       }
 
  inline const char*     getFunctionName()  const { return functionName.c_str();  }
 
  inline const char*     getReason()        const { return reason.c_str();        }
 
  inline const char*     getHandling()      const { return handling.c_str();      }
 
  inline const char*     getFile()          const { return file.c_str();          }
 
  inline const DateTime& getTime()          const { return time;                  }
 
  inline int             getLine()          const { return line;                  }
 
protected:
  // The following members are only set by the friend class \c ErrorOutput
  // to avoid undesired modifications from outside.
 
  friend class ErrorOutput;
 
  MLMessageType messageType;
 
  MLErrorCode   errorCode;
 
  std::string   libraryPrefix;
 
  std::string   fPrefix;
 
  std::string   functionName;
 
  std::string   reason;
 
  std::string   handling;
 
  std::string   file;
 
  DateTime      time;
 
  int           line;
 
 
#if ML_DEPRECATED_SINCE(3,5,0)
 
 
public:
 
  inline ML_DEPRECATED const char* getFPrefix() const { return getFunctionPrefix(); }
 
 
#endif
 
};
 
ML_UTILS_END_NAMESPACE
 
//-----------------------------------------------------------------------------------
//   Stream output for std::ostream
//-----------------------------------------------------------------------------------
namespace std
{
 
  inline ostream& operator<<(ostream& s, const ML_UTILS_NAMESPACE::ErrorOutputInfos &eoi)
  {
    return s << "Message type   :" << eoi.getMessageType()   << endl <<
    "Error Code     :" << eoi.getErrorCode()     << endl <<
    "Library Prefix :" << eoi.getLibraryPrefix() << endl <<
    "Function Prefix:" << eoi.getFunctionPrefix()       << endl <<
    "Function Name  :" << eoi.getFunctionName()  << endl <<
    "Reason         :" << eoi.getReason()        << endl <<
    "Handling       :" << eoi.getHandling()      << endl <<
    "File Name      :" << eoi.getFile()          << endl <<
    "Time Stamp     :" << eoi.getTime()          << endl <<
    // Cast to MLint32 to avoid non unique << operators on 64 bit compilation.
    "Line Number    :" << eoi.getLine() << endl;
  }
 
}
 
#endif // End of __mlErrorOutputInfos_H