summaryrefslogtreecommitdiff
path: root/TAO/tao/TypeCode/TypeCode_Case.h
blob: e97e9e15f78d23d6baf5ddcdfaf95c2f9b5dc60e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
// -*- C++ -*-

//=============================================================================
/**
 *  @file    TypeCode_Case.h
 *
 *  $Id$
 *
 *  Header file for @c TAO::TypeCode::Case type.
 *
 *  @author Ossama Othman
 */
//=============================================================================

#ifndef TAO_TYPECODE_CASE_H
#define TAO_TYPECODE_CASE_H

#include /**/ "ace/pre.h"

#include "ace/config.h"

#if !defined (ACE_LACKS_PRAGMA_ONCE)
# pragma once
#endif /* ACE_LACKS_PRAGMA_ONCE */

#include "tao/TypeCode_Case_Base.h"


namespace TAO
{
  namespace TypeCode
  {

    /**
     * @class Case
     *
     * @brief Representation of an OMG IDL defined @c union @c case.
     *
     * A @c Case contains the corresponding case label value, name and
     * pointer to the @c CORBA::TypeCode for a given OMG IDL @c union
     * @c case.  For
     * example, the cases in following OMG IDL @c union:
     *
     * \code
     *   union Foo switch (short)
     *   {
     *     case 0:
     *     case 1:  short a;
     *     case 2:  long  b;
     *     default: octet c;
     *   };
     * \endcode
     *
     * would be represented using the following statically instantiated
     * @c TAO::TypeCode::Case array:
     *
     * \code
     *   TAO::TypeCode::Case<CORBA::Short, char const *> _tao_cases_Foo[] =
     *     {
     *       { Case<CORBA::Short, char const *> (0, "a", &CORBA::_tc_short),
     *       { Case<CORBA::Short, char const *> (1, "b", &CORBA::_tc_short),
     *       { Case<CORBA::Short, char const *> (2, "c", &CORBA::_tc_long)
     *     };
     * \endcode
     *
     * The @c default case is passed directly to the
     * @c TAO::TypeCode::Union constructor.
     *
     * The template parameter @a DISCRIMINATOR_TYPE is the
     * corresponding C++ type for the IDL defined @c union
     * discriminator type.  For example, a @c union with an IDL @c
     * short discriminator will have a corresponding @c CORBA::Short
     * C++ type.  This template parameter is necessary to allow the
     * actual @c case label value to be stored as its actual type,
     * which is particularly important when marshaling that value into
     * a CDR stream.
     *
     * The template parameter @a STRING_TYPE is either @c char @c
     * const @c * or @c CORBA::String_var.  The latter is only used
     * when creating @c CORBA::tk_union @c TypeCode dynamically, such
     * as through the TypeCodeFactory.
     */
    template <typename DISCRIMINATOR_TYPE, typename STRING_TYPE>
    class Case : public Case_Base<STRING_TYPE>
    {
    public:

      /// Constructor.
      Case (DISCRIMINATOR_TYPE member_label,
            char const * member_name,
            CORBA::TypeCode_ptr * member_type);

      /// Return the IDL @c union case label value embedded within a
      /// @c CORBA::Any.
      virtual CORBA::Any * label (ACE_ENV_SINGLE_ARG_DECL) const;

      /// Marshal this IDL @c union member into the given output CDR
      /// stream.
      virtual bool marshal_label (TAO_OutputCDR & cdr) const;

    private:

      /// IDL @c union case/member label value.
      DISCRIMINATOR_TYPE const label_;

    };

  }  // End namespace TypeCode
}  // End namespace TAO


#ifdef __ACE_INLINE__
# include "tao/TypeCode_Case.inl"
#endif /* __ACE_INLINE__ */

#ifdef ACE_TEMPLATES_REQUIRE_SOURCE
# include "tao/TypeCode_Case.cpp"
#endif /* ACE_TEMPLATES_REQUIRE_SOURCE */

#ifdef ACE_TEMPLATES_REQUIRE_PRAGMA
# pragma implementation ("TypeCode_Case.cpp")
#endif /* ACE_TEMPLATES_REQUIRE_PRAGMA */

#include /**/ "ace/post.h"

#endif /* TAO_TYPECODE_CASE_H */