TAO/tao/DynamicAny/DynCommon.h

   1 // -*- C++ -*-
   2
   3 //=============================================================================
   4 /**
   5  *  @file    DynCommon.h
   6  *
   7  *  @author Jeff Parsons <parsons@cs.wustl.edu>
   8  */
   9 //=============================================================================
  10
  11
  12 #ifndef TAO_DYNCOMMON_H
  13 #define TAO_DYNCOMMON_H
  14 #include /**/ "ace/pre.h"
  15
  16 #include "tao/DynamicAny/DynamicAny.h"
  17
  18 #if !defined (ACE_LACKS_PRAGMA_ONCE)
  19 # pragma once
  20 #endif /* ACE_LACKS_PRAGMA_ONCE */
  21
  22 TAO_BEGIN_VERSIONED_NAMESPACE_DECL
  23
  24 /**
  25  * @class TAO_DynCommon
  26  *
  27  * Contains most of the functionality common to all the
  28  * Dynamic Any implementation classes.
  29  */
  30 class TAO_DynamicAny_Export TAO_DynCommon
  31   : public virtual DynamicAny::DynAny
  32 {
  33 public:
  34   /// Constructor.
  35   TAO_DynCommon (CORBA::Boolean allow_truncation);
  36
  37   /// Destructor.
  38   virtual ~TAO_DynCommon ();
  39
  40   // = Some functions common to all Dynamic Any types.
  41
  42   virtual CORBA::TypeCode_ptr type ();
  43
  44   virtual void assign (DynamicAny::DynAny_ptr dyn_any);
  45
  46   virtual void insert_boolean (CORBA::Boolean value);
  47
  48   virtual void insert_octet (CORBA::Octet value);
  49
  50   virtual void insert_char (CORBA::Char value);
  51   virtual void insert_short (CORBA::Short value);
  52   virtual void insert_ushort (CORBA::UShort value);
  53
  54   virtual void insert_long (CORBA::Long value);
  55
  56   virtual void insert_ulong (CORBA::ULong value);
  57
  58   virtual void insert_float (CORBA::Float value);
  59
  60   virtual void insert_double (CORBA::Double value);
  61
  62   virtual void insert_string (const char * value);
  63
  64   virtual void insert_reference (CORBA::Object_ptr value);
  65
  66   virtual void insert_typecode (CORBA::TypeCode_ptr value);
  67
  68   virtual void insert_longlong (CORBA::LongLong value);
  69
  70   virtual void insert_ulonglong (CORBA::ULongLong value);
  71
  72   virtual void insert_longdouble (CORBA::LongDouble value);
  73
  74   virtual void insert_wchar (CORBA::WChar value);
  75
  76   virtual void insert_wstring (const CORBA::WChar * value);
  77
  78   virtual void insert_any (const CORBA::Any & value);
  79
  80   virtual void insert_dyn_any (DynamicAny::DynAny_ptr value);
  81
  82   virtual void insert_val (CORBA::ValueBase * value);
  83
  84   virtual CORBA::Boolean get_boolean ();
  85
  86   virtual CORBA::Octet get_octet ();
  87
  88   virtual CORBA::Char get_char ();
  89
  90   virtual CORBA::Short get_short ();
  91
  92   virtual CORBA::UShort get_ushort ();
  93
  94   virtual CORBA::Long get_long ();
  95
  96   virtual CORBA::ULong get_ulong ();
  97
  98   virtual CORBA::Float get_float ();
  99
 100   virtual CORBA::Double get_double ();
 101
 102   virtual char * get_string ();
 103
 104   virtual CORBA::Object_ptr get_reference ();
 105
 106   virtual CORBA::TypeCode_ptr get_typecode ();
 107
 108   virtual CORBA::LongLong get_longlong ();
 109
 110   virtual CORBA::ULongLong get_ulonglong ();
 111
 112   virtual CORBA::LongDouble get_longdouble ();
 113
 114   virtual CORBA::WChar get_wchar ();
 115
 116   virtual CORBA::WChar * get_wstring ();
 117
 118   virtual CORBA::Any * get_any ();
 119
 120   virtual DynamicAny::DynAny_ptr get_dyn_any ();
 121
 122   virtual CORBA::ValueBase * get_val ();
 123
 124   virtual CORBA::Boolean seek (CORBA::Long index);
 125
 126   virtual void rewind ();
 127
 128   virtual CORBA::Boolean next ();
 129
 130   virtual DynamicAny::DynAny_ptr copy ();
 131
 132   virtual CORBA::ULong component_count ();
 133
 134   virtual void insert_abstract (CORBA::AbstractBase_ptr value);
 135
 136   virtual CORBA::AbstractBase_ptr get_abstract ();
 137
 138   virtual void insert_boolean_seq (const CORBA::BooleanSeq & value);
 139
 140   virtual void insert_octet_seq (const CORBA::OctetSeq & value);
 141
 142   virtual void insert_char_seq (const CORBA::CharSeq & value);
 143
 144   virtual void insert_short_seq (const CORBA::ShortSeq & value);
 145
 146   virtual void insert_ushort_seq (const CORBA::UShortSeq & value);
 147
 148   virtual void insert_long_seq (const CORBA::LongSeq & value);
 149
 150   virtual void insert_ulong_seq (const CORBA::ULongSeq & value);
 151
 152   virtual void insert_float_seq (const CORBA::FloatSeq & value);
 153
 154   virtual void insert_double_seq (const CORBA::DoubleSeq & value);
 155
 156   virtual void insert_longlong_seq (const CORBA::LongLongSeq & value);
 157
 158   virtual void insert_ulonglong_seq (const CORBA::ULongLongSeq & value);
 159
 160   virtual void insert_longdouble_seq (const CORBA::LongDoubleSeq & value);
 161
 162   virtual void insert_wchar_seq (const CORBA::WCharSeq & value);
 163
 164   virtual CORBA::BooleanSeq * get_boolean_seq ();
 165
 166   virtual CORBA::OctetSeq * get_octet_seq ();
 167
 168   virtual CORBA::CharSeq * get_char_seq ();
 169
 170   virtual CORBA::ShortSeq * get_short_seq ();
 171
 172   virtual CORBA::UShortSeq * get_ushort_seq ();
 173
 174   virtual CORBA::LongSeq * get_long_seq ();
 175
 176   virtual CORBA::ULongSeq * get_ulong_seq ();
 177
 178   virtual CORBA::FloatSeq * get_float_seq ();
 179
 180   virtual CORBA::DoubleSeq * get_double_seq ();
 181
 182   virtual CORBA::LongLongSeq * get_longlong_seq ();
 183
 184   virtual CORBA::ULongLongSeq * get_ulonglong_seq ();
 185
 186   virtual CORBA::LongDoubleSeq * get_longdouble_seq ();
 187
 188   virtual CORBA::WCharSeq * get_wchar_seq ();
 189
 190   /// This sets one of two flags in this base class. CORBA 2.4.2
 191   /// requires that destroy() do nothing if it is called on
 192   /// the result of current_component(), the only non-deep-copying
 193   /// method in the Dynamic Any API. If the boolean arg below is 0,
 194   /// the call is from inside current_component(), and the flag
 195   /// ref_to_component_ is set. If the boolean arg is 1, the call
 196   /// is from inside destroy(), and the container_is_destroying_
 197   /// flag is set, overriding the first flag in the component's
 198   /// destroy() method.
 199   void set_flag (DynamicAny::DynAny_ptr component, CORBA::Boolean destroying);
 200
 201   // Utility functions.
 202
 203   DynamicAny::DynAny_ptr check_component (CORBA::Boolean isValueType = false);
 204
 205   void check_type (CORBA::TypeCode_ptr tc);
 206
 207   static bool is_basic_type_seq (CORBA::TypeCode_ptr tc);
 208
 209   // Accessors
 210
 211   CORBA::Boolean has_components () const;
 212   CORBA::Boolean destroyed () const;
 213   CORBA::Any &the_any ();
 214
 215   // Mutators
 216
 217   void container_is_destroying (CORBA::Boolean val);
 218   void ref_to_component (CORBA::Boolean val);
 219
 220 protected:
 221   /// Were we created by current_component()?
 222   CORBA::Boolean ref_to_component_;
 223
 224   /// Flag to let destroy() call by container override the flag above.
 225   CORBA::Boolean container_is_destroying_;
 226
 227   /// Do we contain other Dynamic Anys?
 228   CORBA::Boolean has_components_;
 229
 230   /// Has destroy() been called on us yet?
 231   CORBA::Boolean destroyed_;
 232
 233   /// Slot of the current component (if any).
 234   CORBA::Long current_position_;
 235
 236   /// Number of components, as defined by CORBA 2.4.2.
 237   CORBA::ULong component_count_;
 238
 239   /// Holder for our type code.
 240   CORBA::TypeCode_var type_;
 241
 242   /// Gets a value only for basic types, but used in insert_*
 243   /// and get_*, defined in this base class.
 244   CORBA::Any any_;
 245
 246   /// Are we allowed to truncate any valuetypes in our hyarchy?
 247   CORBA::Boolean allow_truncation_;
 248
 249 private:
 250   // Utility functions used by insert_* and get_*.
 251   CORBA::TypeCode_ptr check_type_and_unalias (CORBA::TypeCode_ptr tc);
 252 };
 253
 254 TAO_END_VERSIONED_NAMESPACE_DECL
 255
 256 #include /**/ "ace/post.h"
 257 #endif /* TAO_DYNCOMMON_H */