TAO/tao/Argument.h

   1 // -*- C++ -*-
   2
   3 //=============================================================================
   4 /**
   5  *  @file    Argument.h
   6  *
   7  *  @author Jeff Parsons
   8  *  @author Carlos O'Ryan
   9  */
  10 //=============================================================================
  11
  12 #ifndef TAO_ARGUMENT_H
  13 #define TAO_ARGUMENT_H
  14
  15 #include /**/ "ace/pre.h"
  16
  17 #include "tao/Basic_Types.h"
  18
  19 #if !defined (ACE_LACKS_PRAGMA_ONCE)
  20 # pragma once
  21 #endif /* ACE_LACKS_PRAGMA_ONCE */
  22
  23 #include "tao/orbconf.h"
  24 #include /**/ "tao/TAO_Export.h"
  25 #include "tao/ParameterModeC.h"
  26
  27 TAO_BEGIN_VERSIONED_NAMESPACE_DECL
  28
  29 namespace CORBA
  30 {
  31   class Any;
  32 }
  33
  34 class TAO_OutputCDR;
  35 class TAO_InputCDR;
  36
  37 namespace TAO
  38 {
  39   /**
  40    * @class Argument
  41    *
  42    * @brief Base class for argument class templates.
  43    *
  44    * @c Argument subclasses override the virtual methods
  45    *    appropriately.  For example, a stub "IN" argument class
  46    *    template would override the @c marshal() method, but wouldn't
  47    *    need to override the @c demarshal() method.
  48    */
  49   class TAO_Export Argument
  50   {
  51   public:
  52     /// Destructor.
  53     virtual ~Argument ();
  54
  55     /// Marshal the argument into the given CDR output stream.
  56     /**
  57      * @note The default implementation simply returns @c true.
  58      */
  59     virtual CORBA::Boolean marshal (TAO_OutputCDR &cdr);
  60
  61     /// Demarshal the argument from the given CDR input stream.
  62     /**
  63      * @note The default implementation simply returns @c true.
  64      */
  65     virtual CORBA::Boolean demarshal (TAO_InputCDR &);
  66
  67     /// Template method to clone a TAO Argument
  68     virtual Argument* clone ();
  69
  70 #if TAO_HAS_INTERCEPTORS == 1
  71
  72     /**
  73      * @name Portable Interceptor Related Methods
  74      *
  75      * These methods are only used when setting up
  76      * @c PortableInterceptor::RequestInfo instances with the
  77      * appropriate operation-specific parameter list and return
  78      * value, if either or both exist.
  79      */
  80     //@{
  81     /// Populate the given @a CORBA::Any result argument.
  82     /**
  83      * @note The default implementation is a no-op.
  84      */
  85     virtual void interceptor_value (CORBA::Any *) const;
  86
  87     /// Get the parameter mode of this argument
  88     virtual CORBA::ParameterMode mode () const = 0;
  89     //@}
  90
  91 #endif /* TAO_HAS_INTERCEPTORS == 1 */
  92   };
  93
  94 #if TAO_HAS_INTERCEPTORS == 1
  95   class TAO_Export InArgument : public Argument
  96   {
  97   public:
  98     virtual CORBA::ParameterMode mode () const;
  99   };
 100 #else
 101   typedef Argument InArgument;
 102 #endif
 103
 104 #if TAO_HAS_INTERCEPTORS == 1
 105   class TAO_Export InoutArgument : public Argument
 106   {
 107   public:
 108     virtual CORBA::ParameterMode mode () const;
 109   };
 110 #else
 111   typedef Argument InoutArgument;
 112 #endif
 113
 114 #if TAO_HAS_INTERCEPTORS == 1
 115   class TAO_Export OutArgument : public Argument
 116   {
 117   public:
 118     virtual CORBA::ParameterMode mode () const;
 119   };
 120 #else
 121   typedef Argument OutArgument;
 122 #endif
 123
 124 #if TAO_HAS_INTERCEPTORS == 1
 125   class TAO_Export RetArgument : public Argument
 126   {
 127   public:
 128     virtual CORBA::ParameterMode mode () const;
 129   };
 130 #else
 131   typedef Argument RetArgument;
 132 #endif
 133
 134   class TAO_Export Void_Return_Argument : public RetArgument
 135   {
 136   public:
 137     virtual Argument* clone ();
 138   };
 139 }
 140
 141 TAO_END_VERSIONED_NAMESPACE_DECL
 142
 143 #include /**/ "ace/post.h"
 144
 145 #endif /* TAO_ARGUMENT_H */