TAO/tao/UserException.h

   1 // -*- C++ -*-
   2
   3 //=============================================================================
   4 /**
   5  *  @file    UserException.h
   6  *
   7  *  CORBA::UserException class header.
   8  *
   9  *  @author DOC Group at Vanderbilt U, Wash U, and UCI
  10  *  @author Ossama Othman <ossama@dre.vanderbilt.edu>
  11  */
  12 //=============================================================================
  13
  14 #ifndef TAO_USER_EXCEPTION_H
  15 #define TAO_USER_EXCEPTION_H
  16
  17 #include /**/ "ace/pre.h"
  18
  19 #include /**/ "tao/TAO_Export.h"
  20
  21 #if !defined (ACE_LACKS_PRAGMA_ONCE)
  22 # pragma once
  23 #endif /* ACE_LACKS_PRAGMA_ONCE */
  24
  25 #include "tao/Exception.h"
  26
  27 TAO_BEGIN_VERSIONED_NAMESPACE_DECL
  28
  29 namespace CORBA
  30 {
  31   /**
  32    * @class UserException
  33    *
  34    * @brief Application- or OMG- defined CORBA exception sub-class.
  35    *
  36    * User exceptions can be defined in application OMG IDL or by the
  37    * OMG itself for IDL interfaces and services it defines.
  38    */
  39   class TAO_Export UserException : public Exception
  40   {
  41   public:
  42
  43     /// Copy constructor.
  44     UserException (UserException const &rhs);
  45
  46     /// Destructor.
  47     virtual ~UserException (void);
  48
  49     /// Assignment operator.
  50     UserException &operator= (UserException const &rhs);
  51
  52     /// The narrow operation.
  53     static UserException *_downcast (CORBA::Exception *exception);
  54
  55     /// The const version of narrow operation
  56     static const UserException *_downcast (CORBA::Exception const *exception);
  57
  58     virtual void _raise (void) const = 0;
  59
  60     virtual CORBA::TypeCode_ptr _tao_type (void) const;
  61
  62     // = TAO specific extension.
  63
  64     /// Constructor from a repository id.
  65     UserException (char const *repository_id, char const *local_name);
  66
  67     /// Returns a string containing information about the exception. This
  68     /// function is not CORBA compliant.
  69     virtual ACE_CString _info (void) const;
  70
  71   protected:
  72     /// Default constructor.
  73     UserException (void);
  74   };
  75
  76 }
  77
  78 TAO_END_VERSIONED_NAMESPACE_DECL
  79
  80 #if defined (__ACE_INLINE__)
  81 # include "tao/UserException.inl"
  82 #endif /* __ACE_INLINE__ */
  83
  84 #include /**/"ace/post.h"
  85
  86 #endif /* TAO_USER_EXCEPTION_H */