CFx SDK Documentation  2020SP3
daiErrorEvent.h
Go to the documentation of this file.
1 // Copyright (C) 2002-2019, 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 Open Design Alliance software pursuant to a license
16 // agreement with Open Design Alliance.
17 // Open Design Alliance Copyright (C) 2002-2019 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 _DAI_ERROREVENT_H_
25 #define _DAI_ERROREVENT_H_
26 
27 #include "OdPlatformSettings.h"
28 #include "daiBuildOptions.h"
29 #include "daiError/daiErrorId.h"
30 #include "daiBaseEvent.h"
31 
32 #include "OdString.h"
33 
34 namespace OdDAI
35 {
36  class daiErrorEvent;
38 
40  : public daiBaseEvent
41  {
42  public:
43  daiErrorEvent(const char* functionId, daiErrorId errorId, const char* description = 0);
45  virtual ~daiErrorEvent();
46 
47  daiErrorId error() const;
48  const char* function() const;
49  const char* description() const;
50 
51  static daiErrorEventPtr makeErrorEvent(daiErrorId errorId, const char* description, const char* functionName);
52 
53  private:
54  daiErrorId m_error;
55  OdAnsiString m_description;
56  OdAnsiString m_functionId;
57  };
58 
59 
60 #define MAKE_ERROR_EVENT(errorId, description) daiErrorEvent::makeErrorEvent(errorId, description, TD_FUNC)
61 
62 }
63 
64 #endif
daiErrorId.h
daiBaseEvent.h
OdSharedPtr
Definition: SharedPtr.h:49
OdDAI::daiErrorId
unsigned int daiErrorId
Definition: daiErrorId.h:90
OdDAI
Definition: daiAccessDefines.h:31
OdDAI::daiBaseEvent
Definition: daiBaseEvent.h:42
OdString.h
OdDAI::daiErrorEvent::daiErrorEvent
daiErrorEvent(const daiErrorEvent &other)
OdDAI::daiErrorEvent::makeErrorEvent
static daiErrorEventPtr makeErrorEvent(daiErrorId errorId, const char *description, const char *functionName)
OdDAI::daiErrorEvent::description
const char * description() const
OdPlatformSettings.h
OdDAI::daiErrorEvent::daiErrorEvent
daiErrorEvent(const char *functionId, daiErrorId errorId, const char *description=0)
daiBuildOptions.h
OdDAI::daiErrorEvent::error
daiErrorId error() const
OdDAI::daiErrorEventPtr
OdSharedPtr< daiErrorEvent > daiErrorEventPtr
Definition: daiErrorEvent.h:36
OdDAI::daiErrorEvent::~daiErrorEvent
virtual ~daiErrorEvent()
DAI_EXPORT
#define DAI_EXPORT
Definition: daiBuildOptions.h:28
OdDAI::daiErrorEvent
Definition: daiErrorEvent.h:41