CFx SDK Documentation  2023 SP0
AECError.h
Go to the documentation of this file.
1 // Copyright (C) 2002-2017, Open Design Alliance (the "Alliance").
3 // All rights reserved.
4 //
5 // This software and its documentation and related materials are owned by
6 // the Alliance. The software may only be incorporated into application
7 // programs owned by members of the Alliance, subject to a signed
8 // Membership Agreement and Supplemental Software License Agreement with the
9 // Alliance. The structure and organization of this software are the valuable
10 // trade secrets of the Alliance and its suppliers. The software is also
11 // protected by copyright law and international treaty provisions. Application
12 // programs incorporating this software must include the following statement
13 // with their copyright notices:
14 //
15 // This application incorporates Teigha(R) software pursuant to a license
16 // agreement with Open Design Alliance.
17 // Teigha(R) Copyright (C) 2002-2017 by Open Design Alliance.
18 // All rights reserved.
19 //
20 // By use of this software, its documentation or related materials, you
21 // acknowledge and accept the above terms.
23 
24 #ifndef __AECERROR_H__
25 #define __AECERROR_H__
26 
27 #include "OdErrorContext.h"
28 #include "DrxError.h"
29 
30 class AECErrorContext;
31 
37 class AECError : public OdError {
38 public:
39  explicit AECError( AECErrorContext* pErrorContext );
40  AECError( unsigned int nAecErrorCode );
41 };
42 
48 class AECBASE_API AECErrorContext : public TxErrorContext
49 {
50  unsigned int m_nAecErrorCode;
51 public:
53 
54  // Initializes AECErrorContext with AEC-specific message code.
55  // See also AECModule::formatMessage(), AECModule::formatMsg().
56  OdSmartPtr<OdErrorContext> init( unsigned int nAecErrorCode );
57 
58  // OdErrorContext override.
59  OdResult code() const;
60 
61  // OdErrorContext override.
63 
64  // Returns AEC modeule name.
65  virtual OdString drxAppName() const;
66 };
67 
68 inline AECError::AECError( AECErrorContext* pErrorContext ) : OdError( static_cast<OdErrorContext*>( pErrorContext ) ) {}
69 
70 #endif //__AECERROR_H__
OdResult
Definition: OdResult.h:29
OdResult code() const
virtual OdString drxAppName() const
OdString description() const
OdSmartPtr< OdErrorContext > init(unsigned int nAecErrorCode)
AECError(AECErrorContext *pErrorContext)
Definition: AECError.h:68
AECError(unsigned int nAecErrorCode)