TAO: Value_TypeCode.h Source File

Go to the documentation of this file.
00001 // -*- C++ -*-
00002 
00003 //=============================================================================
00004 /**
00005  *  @file    Value_TypeCode.h
00006  *
00007  *  $Id: Value_TypeCode.h 83309 2008-10-17 13:57:39Z johnnyw $
00008  *
00009  *  Header file for a @c tk_value and @c tk_event
00010  *  @c CORBA::TypeCodes.
00011  *
00012  *  @author Ossama Othman <ossama@dre.vanderbilt.edu>
00013  */
00014 //=============================================================================
00015 
00016 #ifndef TAO_VALUE_TYPECODE_H
00017 #define TAO_VALUE_TYPECODE_H
00018 
00019 #include /**/ "ace/pre.h"
00020 
00021 #include "tao/AnyTypeCode/TypeCode.h"
00022 
00023 #if !defined (ACE_LACKS_PRAGMA_ONCE)
00024 # pragma once
00025 #endif /* ACE_LACKS_PRAGMA_ONCE */
00026 
00027 #include "tao/AnyTypeCode/TypeCode_Base_Attributes.h"
00028 #include "tao/AnyTypeCode/ValueModifierC.h"
00029 #include "tao/AnyTypeCode/VisibilityC.h"
00030 
00031 TAO_BEGIN_VERSIONED_NAMESPACE_DECL
00032 
00033 namespace TAO
00034 {
00035   namespace TypeCode
00036   {
00037     template<typename StringType, typename TypeCodeType> struct Value_Field;
00038 
00039     /**
00040      * @class Value
00041      *
00042      * @brief @c CORBA::TypeCode implementation for an OMG IDL
00043      *        @c valuetype or @c event.
00044      *
00045      * This class implements a @c CORBA::TypeCode for an OMG IDL
00046      * @c valuetype or @c event.
00047      */
00048     template <typename StringType,
00049               typename TypeCodeType,
00050               class FieldArrayType,
00051               class RefCountPolicy>
00052     class Value
00053       : public CORBA::TypeCode,
00054         private RefCountPolicy
00055     {
00056     public:
00057 
00058       /// Constructor.
00059       Value (CORBA::TCKind kind,
00060              char const * id,
00061              char const * name,
00062              CORBA::ValueModifier modifier,
00063              TypeCodeType const & concrete_base,
00064              FieldArrayType const & fields,
00065              CORBA::ULong nfields);
00066 
00067       /// Constructor used for recursive TypeCodes.
00068       Value (CORBA::TCKind kind,
00069               char const * id);
00070 
00071       /**
00072        * @name TAO-specific @c CORBA::TypeCode Methods
00073        *
00074        * Methods required by TAO's implementation of the
00075        * @c CORBA::TypeCode class.
00076        *
00077        * @see @c CORBA::TypeCode
00078        */
00079       //@{
00080       virtual bool tao_marshal (TAO_OutputCDR & cdr,
00081                                 CORBA::ULong offset) const;
00082       virtual void tao_duplicate (void);
00083       virtual void tao_release (void);
00084       //@}
00085 
00086     protected:
00087 
00088       /**
00089        * @name @c TAO CORBA::TypeCode Template Methods
00090        *
00091        * @c tk_value or @c tk_event @c CORBA::TypeCode -specific
00092        * template methods.
00093        *
00094        * @see @c CORBA::TypeCode
00095        */
00096       //@{
00097       virtual CORBA::Boolean equal_i (CORBA::TypeCode_ptr tc) const;
00098       virtual CORBA::Boolean equivalent_i (CORBA::TypeCode_ptr tc) const;
00099       virtual CORBA::TypeCode_ptr get_compact_typecode_i (void) const;
00100       virtual char const * id_i (void) const;
00101       virtual char const * name_i (void) const;
00102       virtual CORBA::ULong member_count_i (void) const;
00103       virtual char const * member_name_i (CORBA::ULong index) const;
00104       virtual CORBA::TypeCode_ptr member_type_i (CORBA::ULong index) const;
00105       virtual CORBA::Visibility member_visibility_i (CORBA::ULong index) const;
00106       virtual CORBA::ValueModifier type_modifier_i (void) const;
00107       virtual CORBA::TypeCode_ptr concrete_base_type_i (void) const;
00108       //@}
00109 
00110     protected:
00111 
00112       /**
00113        * @c Valuetype Attributes
00114        *
00115        * Attributes representing the structure of an OMG IDL
00116        * @c valuetype or @c event.
00117        *
00118        * @note These attributes are declared in the order in which
00119        *       they are marshaled into a CDR stream in order to
00120        *       increase cache hits by improving spatial locality.
00121        */
00122       //@{
00123 
00124       /// Base attributes containing repository ID and name of
00125       /// @c valuetype.
00126       Base_Attributes<StringType> base_attributes_;
00127 
00128       /// The @c ValueModifier of the @c valuetype of @c eventtype
00129       /// represented by this @c TypeCode.
00130       CORBA::ValueModifier type_modifier_;
00131 
00132       /// The @c TypeCode corresponding to the concrete base
00133       /// @c valuetype or @c eventtype.
00134       TypeCodeType concrete_base_;
00135 
00136       /// The number of fields in the OMG IDL value.
00137       CORBA::ULong nfields_;
00138 
00139       /// Array of @c TAO::TypeCode fields representing structure of the
00140       /// OMG IDL defined @c value.
00141       FieldArrayType fields_;
00142 
00143       //@}
00144 
00145     };
00146 
00147   }  // End namespace TypeCode
00148 }  // End namespace TAO
00149 
00150 TAO_END_VERSIONED_NAMESPACE_DECL
00151 
00152 #ifdef __ACE_INLINE__
00153 # include "tao/AnyTypeCode/Value_TypeCode.inl"
00154 #endif  /* __ACE_INLINE__ */
00155 
00156 #ifdef ACE_TEMPLATES_REQUIRE_SOURCE
00157 # include "tao/AnyTypeCode/Value_TypeCode.cpp"
00158 #endif /* ACE_TEMPLATES_REQUIRE_SOURCE */
00159 
00160 #ifdef ACE_TEMPLATES_REQUIRE_PRAGMA
00161 # pragma implementation ("Value_TypeCode.cpp")
00162 #endif /* ACE_TEMPLATES_REQUIRE_PRAGMA */
00163 
00164 
00165 #include /**/ "ace/post.h"
00166 
00167 #endif /* TAO_VALUE_TYPECODE_H */