xref: /aoo42x/main/autodoc/inc/ary/idl/i_constant.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_CONSTANT_HXX
25 #define ARY_IDL_I_CONSTANT_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_constant
38 {
39     struct attr;
40 }
41 
42 
43 /** Represents an IDL constant.
44 */
45 class Constant : public CodeEntity
46 {
47   public:
48     enum E_ClassId { class_id = 2012 };
49 
50     // LIFECYCLE
51                         Constant(
52                             const String &      i_sName,
53                             Ce_id               i_nOwner,
54                             Ce_id               i_nNameRoom,
55                             Type_id             i_nType,
56                             const String &      i_sInitValue );
57                         ~Constant();
58     // INQUIRY
59     Type_id             Type() const;
60     const String &      Value() const;
61 
62 
63   private:
64     // Interface csv::ConstProcessorClient:
65     virtual void        do_Accept(
66                             csv::ProcessorIfc & io_processor ) const;
67     // Interface ary::Object
68     virtual ClassId     get_AryClass() const;
69 
70     // Interface CodeEntity
71     virtual const String &  inq_LocalName() const;
72     virtual Ce_id           inq_NameRoom() const;
73     virtual Ce_id           inq_Owner() const;
74     virtual E_SightLevel    inq_SightLevel() const;
75 
76     friend struct ifc_constant::attr;
77 
78     // DATA
79     String              sName;
80     Ce_id               nNameRoom;
81     Ce_id               nOwner;
82 
83     Type_id             nType;
84     String              sInitValue;
85 };
86 
87 
88 
89 
90 // IMPLEMENTATION
91 inline Type_id
Type() const92 Constant::Type() const
93 {
94     return nType;
95 }
96 
97 inline const String &
Value() const98 Constant::Value() const
99 {
100     return sInitValue;
101 }
102 
103 
104 
105 
106 }   // namespace idl
107 }   // namespace ary
108 #endif
109