xref: /aoo42x/main/autodoc/inc/ary/idl/i_enum.hxx (revision 1c78a5d6)
1 /**************************************************************
2  *
3  * Licensed to the Apache Software Foundation (ASF) under one
4  * or more contributor license agreements.  See the NOTICE file
5  * distributed with this work for additional information
6  * regarding copyright ownership.  The ASF licenses this file
7  * to you under the Apache License, Version 2.0 (the
8  * "License"); you may not use this file except in compliance
9  * with the License.  You may obtain a copy of the License at
10  *
11  *   http://www.apache.org/licenses/LICENSE-2.0
12  *
13  * Unless required by applicable law or agreed to in writing,
14  * software distributed under the License is distributed on an
15  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16  * KIND, either express or implied.  See the License for the
17  * specific language governing permissions and limitations
18  * under the License.
19  *
20  *************************************************************/
21 
22 
23 
24 #ifndef ARY_IDL_I_ENUM_HXX
25 #define ARY_IDL_I_ENUM_HXX
26 
27 // BASE CLASSES
28 #include <ary/idl/i_ce.hxx>
29 
30 
31 
32 
33 namespace ary
34 {
35 namespace idl
36 {
37 namespace ifc_enum
38 {
39     struct attr;
40 }
41 
42 
43 /** Represents an IDL enum.
44 */
45 class Enum : public CodeEntity
46 {
47   public:
48     enum E_ClassId { class_id = 2005 };
49     // LIFECYCLE
50                         Enum(
51                             const String &      i_sName,
52                             Ce_id               i_nOwner );
53                         ~Enum();
54     // ACCESS
55     void                Add_Value(
56                             Ce_id               i_nValue );
57   private:
58     // Interface csv::ConstProcessorClient:
59     virtual void        do_Accept(
60                             csv::ProcessorIfc & io_processor ) const;
61     // Interface ary::Object
62     virtual ClassId     get_AryClass() const;
63 
64     // Interface CodeEntity
65     virtual const String &  inq_LocalName() const;
66     virtual Ce_id           inq_NameRoom() const;
67     virtual Ce_id           inq_Owner() const;
68     virtual E_SightLevel    inq_SightLevel() const;
69 
70     // Locals
71     typedef std::vector<Ce_id>   ValueList;
72     friend struct ifc_enum::attr;
73 
74     // DATA
75     String              sName;
76     Ce_id               nOwner;
77 
78     ValueList           aValues;
79 };
80 
81 
82 
83 
84 // IMPLEMENTATION
85 inline void
Add_Value(Ce_id i_nValue)86 Enum::Add_Value( Ce_id i_nValue )
87 {
88     aValues.push_back(i_nValue);
89 }
90 
91 
92 
93 
94 }   // namespace idl
95 }   // namespace ary
96 #endif
97