OdErrorContext.h

Go to the documentation of this file.

// Copyright (C) 2002-2024, Open Design Alliance (the "Alliance"). 
// All rights reserved. 
// 
// This software and its documentation and related materials are owned by 
// the Alliance. The software may only be incorporated into application 
// programs owned by members of the Alliance, subject to a signed 
// Membership Agreement and Supplemental Software License Agreement with the
// Alliance. The structure and organization of this software are the valuable  
// trade secrets of the Alliance and its suppliers. The software is also 
// protected by copyright law and international treaty provisions. Application  
// programs incorporating this software must include the following statement 
// with their copyright notices:
//   
//   This application incorporates Open Design Alliance software pursuant to a license 
//   agreement with Open Design Alliance.
//   Open Design Alliance Copyright (C) 2002-2024 by Open Design Alliance. 
//   All rights reserved.
//
// By use of this software, its documentation or related materials, you 
// acknowledge and accept the above terms.
 
 
#ifndef _OdErrorContext_h_Included_
#define _OdErrorContext_h_Included_
 
#include "OdaDefs.h"
#include "RxObjectImpl.h"
#include "OdString.h"
 
#include "TD_PackPush.h"

class FIRSTDLL_EXPORT OdErrorContext : public OdRxObject
{
protected:
  OdErrorContext* m_pPreviousError;
  OdErrorContext() : m_pPreviousError(0) {}
  OdErrorContext(OdErrorContext* pPreviousError);
public:

  virtual ~OdErrorContext();
  
  virtual OdString description() const = 0;
  
  virtual OdResult code() const = 0;
  
  OdString completeDescription() const;
  OdErrorContext* getPreviousError() const { return m_pPreviousError; }

  void setPreviousError(OdErrorContext* pPreviousError);
};
 
/*  \details
  This class is used by OdError constructed from an error code
*/
class FIRSTDLL_EXPORT OdDefaultErrorContext : public OdErrorContext
{
  OdResult m_res;
public:
  OdDefaultErrorContext(OdResult err, OdErrorContext* pPreviousError = nullptr);
  virtual OdResult code() const override;
  virtual OdString description() const override;
};
 
/*  \details
  This class is used by OdError constructed from an error message.
*/
class FIRSTDLL_EXPORT OdUserErrorContext : public OdErrorContext
{
  OdString m_sErrorMessage;
public:
  OdUserErrorContext(const OdString& szErrorMessage, OdErrorContext* pPreviousError = nullptr);
  virtual OdResult code() const override;
  virtual OdString description() const override;
};
 
/*  \details
  This class is used by OdError_FileException and its descendants
*/
class FIRSTDLL_EXPORT OdFileExceptionContext : public OdDefaultErrorContext
{
  OdString m_fileName;
  OdString m_extended;
public:
  OdFileExceptionContext(OdResult error, const OdString& fileName, const OdString& extended = OdString::kEmpty, OdErrorContext* pPreviousError = nullptr);
  OdString getFileName() const;
  virtual OdString description() const override;
};
 
#include "TD_PackPop.h"
 
#endif