summaryrefslogtreecommitdiff
path: root/TAO/tao/TypeCode_Enumerator.h
blob: 9e75532ecfcd1fbfa093a973123490a21bb09f13 (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
// -*- C++ -*-

//=============================================================================
/**
 *  @file    TypeCode_Enumerator.h
 *
 *  $Id$
 *
 *  Header file for @c TAO::TypeCode::Enumerator type.
 *
 *  @author Ossama Othman <ossama@dre.vanderbilt.edu>
 */
//=============================================================================

#ifndef TAO_TYPECODE_ENUMERATOR_H
#define TAO_TYPECODE_ENUMERATOR_H

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

#include "tao/TAO_Export.h"

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

#include "tao/orbconf.h"

namespace CORBA
{
  class TypeCode;
  typedef TypeCode* TypeCode_ptr;
}

namespace TAO
{
  namespace TypeCode
  {
    /**
     * @struct Enumerator
     *
     * @brief Enumerator of an OMG IDL defined enumeration (@c enum).
     *
     * An @c Enumerator contains the name for a given OMG IDL defined
     * enumeration.  For example, the enumerators in following OMG IDL
     * enumeration:
     *
     * \code
     *   enum Color
     *   {
     *     RED;
     *     BLUE;
     *   };
     * \endcode
     *
     * would be represented using the following @c
     * TAO::TypeCode::Enumerator array:
     *
     * \code
     *   TAO::TypeCode::Enumerator _tao_enumerators_Color[] =
     *     {
     *       "RED",
     *       "BLUE",
     *     };
     * \endcode
     */
    template <typename STRING_TYPE>
    struct Enumerator
    {

      /// Return the name of the @c Enumerator.
      /**
       * @note This method unfortunately exists so that we can
       *       retrieve the underlying string when the @a STRING_TYPE
       *       is @c CORBA::String_var rather than the
       *       @c CORBA::String_var itself.  This is necessary to
       *       silence a warning about better conversion sequences
       *       exhibited by some C++ compilers.
       */
      char const * get_name (void) const;

      /// The name of the enumerator.
      STRING_TYPE name;

    };

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


// If we didn't have to worry about better conversion sequence
// warnings, and drop the Enumerator<>::get_name() method, we could
// drop the below #include directives and remove the files contained
// within them altogether.

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

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

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

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

#endif /* TAO_TYPECODE_ENUMERATOR_H */