AECError.h

Go to the documentation of this file.

 
// Copyright (C) 2002-2022, 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-2022 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 __AECERROR_H__
#define __AECERROR_H__
 
#include "OdErrorContext.h"
#include "DrxError.h"
 
class AECErrorContext;
 
class AECError : public OdError {
public:
  explicit AECError( AECErrorContext* pErrorContext );
  AECError( unsigned int nAecErrorCode );
};
 
class AECBASE_API AECErrorContext : public TxErrorContext
{
  unsigned int m_nAecErrorCode;
public:
  AECErrorContext();
 
  // Initializes AECErrorContext with AEC-specific message code.
  // See also AECModule::formatMessage(), AECModule::formatMsg().
  OdSmartPtr<OdErrorContext> init( unsigned int nAecErrorCode );
 
  // OdErrorContext override.
  OdResult code() const;
 
  // OdErrorContext override.
  OdString description() const;
 
  // Returns AEC modeule name.
  virtual OdString drxAppName() const;
};
 
inline AECError::AECError( AECErrorContext* pErrorContext ) : OdError( static_cast<OdErrorContext*>( pErrorContext ) ) {}
 
#endif  //__AECERROR_H__