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     /// Copy constructor.
  43     UserException (UserException const &rhs);
  44
  45     /// Destructor.
  46     virtual ~UserException () = default;
  47
  48     /// Assignment operator.
  49     UserException &operator= (UserException const &rhs);
  50
  51     /// The narrow operation.
  52     static UserException *_downcast (CORBA::Exception *exception);
  53
  54     /// The const version of narrow operation
  55     static const UserException *_downcast (CORBA::Exception const *exception);
  56
  57     virtual void _raise () const = 0;
  58
  59     virtual CORBA::TypeCode_ptr _tao_type () const;
  60
  61     // = TAO specific extension.
  62
  63     /// Constructor from a repository id.
  64     UserException (char const *repository_id, char const *local_name);
  65
  66     /// Returns a string containing information about the exception. This
  67     /// function is not CORBA compliant.
  68     virtual ACE_CString _info () const;
  69
  70   protected:
  71     /// Default constructor.
  72     UserException ();
  73   };
  74 }
  75
  76 TAO_END_VERSIONED_NAMESPACE_DECL
  77
  78 #if defined (__ACE_INLINE__)
  79 # include "tao/UserException.inl"
  80 #endif /* __ACE_INLINE__ */
  81
  82 #include /**/"ace/post.h"
  83
  84 #endif /* TAO_USER_EXCEPTION_H */