xref: /aoo4110/main/autodoc/inc/ary/idl/i_property.hxx (revision b1cdbd2c)
1*b1cdbd2cSJim Jagielski /**************************************************************
2*b1cdbd2cSJim Jagielski  *
3*b1cdbd2cSJim Jagielski  * Licensed to the Apache Software Foundation (ASF) under one
4*b1cdbd2cSJim Jagielski  * or more contributor license agreements.  See the NOTICE file
5*b1cdbd2cSJim Jagielski  * distributed with this work for additional information
6*b1cdbd2cSJim Jagielski  * regarding copyright ownership.  The ASF licenses this file
7*b1cdbd2cSJim Jagielski  * to you under the Apache License, Version 2.0 (the
8*b1cdbd2cSJim Jagielski  * "License"); you may not use this file except in compliance
9*b1cdbd2cSJim Jagielski  * with the License.  You may obtain a copy of the License at
10*b1cdbd2cSJim Jagielski  *
11*b1cdbd2cSJim Jagielski  *   http://www.apache.org/licenses/LICENSE-2.0
12*b1cdbd2cSJim Jagielski  *
13*b1cdbd2cSJim Jagielski  * Unless required by applicable law or agreed to in writing,
14*b1cdbd2cSJim Jagielski  * software distributed under the License is distributed on an
15*b1cdbd2cSJim Jagielski  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16*b1cdbd2cSJim Jagielski  * KIND, either express or implied.  See the License for the
17*b1cdbd2cSJim Jagielski  * specific language governing permissions and limitations
18*b1cdbd2cSJim Jagielski  * under the License.
19*b1cdbd2cSJim Jagielski  *
20*b1cdbd2cSJim Jagielski  *************************************************************/
21*b1cdbd2cSJim Jagielski 
22*b1cdbd2cSJim Jagielski 
23*b1cdbd2cSJim Jagielski 
24*b1cdbd2cSJim Jagielski #ifndef ARY_IDL_I_PROPERTY_HXX
25*b1cdbd2cSJim Jagielski #define ARY_IDL_I_PROPERTY_HXX
26*b1cdbd2cSJim Jagielski 
27*b1cdbd2cSJim Jagielski // BASE CLASSES
28*b1cdbd2cSJim Jagielski #include <ary/idl/i_ce.hxx>
29*b1cdbd2cSJim Jagielski 
30*b1cdbd2cSJim Jagielski 
31*b1cdbd2cSJim Jagielski 
32*b1cdbd2cSJim Jagielski 
33*b1cdbd2cSJim Jagielski namespace ary
34*b1cdbd2cSJim Jagielski {
35*b1cdbd2cSJim Jagielski namespace idl
36*b1cdbd2cSJim Jagielski {
37*b1cdbd2cSJim Jagielski namespace ifc_property
38*b1cdbd2cSJim Jagielski {
39*b1cdbd2cSJim Jagielski     struct attr;
40*b1cdbd2cSJim Jagielski }
41*b1cdbd2cSJim Jagielski 
42*b1cdbd2cSJim Jagielski 
43*b1cdbd2cSJim Jagielski /** Represents an IDL property.
44*b1cdbd2cSJim Jagielski */
45*b1cdbd2cSJim Jagielski class Property : public CodeEntity
46*b1cdbd2cSJim Jagielski {
47*b1cdbd2cSJim Jagielski   public:
48*b1cdbd2cSJim Jagielski     enum E_ClassId { class_id = 2004 };
49*b1cdbd2cSJim Jagielski 
50*b1cdbd2cSJim Jagielski     class Stereotypes
51*b1cdbd2cSJim Jagielski     {
52*b1cdbd2cSJim Jagielski       public:
53*b1cdbd2cSJim Jagielski         enum E_Flags
54*b1cdbd2cSJim Jagielski         {
55*b1cdbd2cSJim Jagielski             readonly = 1,
56*b1cdbd2cSJim Jagielski             bound = 2,
57*b1cdbd2cSJim Jagielski             constrained = 4,
58*b1cdbd2cSJim Jagielski             maybeambiguous = 8,
59*b1cdbd2cSJim Jagielski             maybedefault = 16,
60*b1cdbd2cSJim Jagielski             maybevoid = 32,
61*b1cdbd2cSJim Jagielski             removable = 64,
62*b1cdbd2cSJim Jagielski             transient = 128,
63*b1cdbd2cSJim Jagielski             s_MAX
64*b1cdbd2cSJim Jagielski         };
Stereotypes()65*b1cdbd2cSJim Jagielski                             Stereotypes()       : nFlags(0) {}
66*b1cdbd2cSJim Jagielski 
HasAny() const67*b1cdbd2cSJim Jagielski         bool                HasAny() const      { return nFlags != 0; }
IsReadOnly() const68*b1cdbd2cSJim Jagielski         bool                IsReadOnly() const  { return (nFlags & UINT32(readonly)) != 0; }
IsBound() const69*b1cdbd2cSJim Jagielski         bool                IsBound() const     { return (nFlags & UINT32(bound)) != 0; }
IsConstrained() const70*b1cdbd2cSJim Jagielski         bool                IsConstrained() const
71*b1cdbd2cSJim Jagielski                                                 { return (nFlags & UINT32(constrained)) != 0; }
IsMayBeAmbiguous() const72*b1cdbd2cSJim Jagielski         bool                IsMayBeAmbiguous() const
73*b1cdbd2cSJim Jagielski                                                 { return (nFlags & UINT32(maybeambiguous)) != 0; }
IsMayBeDefault() const74*b1cdbd2cSJim Jagielski         bool                IsMayBeDefault() const
75*b1cdbd2cSJim Jagielski                                                 { return (nFlags & UINT32(maybedefault)) != 0; }
IsMayBeVoid() const76*b1cdbd2cSJim Jagielski         bool                IsMayBeVoid() const { return (nFlags & UINT32(maybevoid)) != 0; }
IsRemovable() const77*b1cdbd2cSJim Jagielski         bool                IsRemovable() const { return (nFlags & UINT32(removable)) != 0; }
IsTransient() const78*b1cdbd2cSJim Jagielski         bool                IsTransient() const { return (nFlags & UINT32(transient)) != 0; }
79*b1cdbd2cSJim Jagielski 
Set_Flag(E_Flags i_flag)80*b1cdbd2cSJim Jagielski         void                Set_Flag(
81*b1cdbd2cSJim Jagielski                                 E_Flags         i_flag )
82*b1cdbd2cSJim Jagielski                                                 { nFlags |= UINT32(i_flag); }
83*b1cdbd2cSJim Jagielski       private:
84*b1cdbd2cSJim Jagielski         // DATA
85*b1cdbd2cSJim Jagielski         UINT32              nFlags;
86*b1cdbd2cSJim Jagielski     };
87*b1cdbd2cSJim Jagielski 
88*b1cdbd2cSJim Jagielski 
89*b1cdbd2cSJim Jagielski     // LIFECYCLE
90*b1cdbd2cSJim Jagielski                         Property(
91*b1cdbd2cSJim Jagielski                             const String &      i_sName,
92*b1cdbd2cSJim Jagielski                             Ce_id               i_nService,
93*b1cdbd2cSJim Jagielski                             Ce_id               i_nModule,
94*b1cdbd2cSJim Jagielski                             Type_id             i_nType,
95*b1cdbd2cSJim Jagielski                             Stereotypes         i_stereotypes );
96*b1cdbd2cSJim Jagielski                         ~Property();
97*b1cdbd2cSJim Jagielski     // INQUIRY
98*b1cdbd2cSJim Jagielski     Type_id             Type() const;
99*b1cdbd2cSJim Jagielski 
100*b1cdbd2cSJim Jagielski   private:
101*b1cdbd2cSJim Jagielski     // Interface csv::ConstProcessorClient:
102*b1cdbd2cSJim Jagielski     virtual void        do_Accept(
103*b1cdbd2cSJim Jagielski                             csv::ProcessorIfc & io_processor ) const;
104*b1cdbd2cSJim Jagielski     // Interface ary::Object:
105*b1cdbd2cSJim Jagielski     virtual ClassId     get_AryClass() const;
106*b1cdbd2cSJim Jagielski 
107*b1cdbd2cSJim Jagielski     // Interface CodeEntity
108*b1cdbd2cSJim Jagielski     virtual const String &  inq_LocalName() const;
109*b1cdbd2cSJim Jagielski     virtual Ce_id           inq_NameRoom() const;
110*b1cdbd2cSJim Jagielski     virtual Ce_id           inq_Owner() const;
111*b1cdbd2cSJim Jagielski     virtual E_SightLevel    inq_SightLevel() const;
112*b1cdbd2cSJim Jagielski 
113*b1cdbd2cSJim Jagielski     friend struct ifc_property::attr;
114*b1cdbd2cSJim Jagielski 
115*b1cdbd2cSJim Jagielski     // DATA
116*b1cdbd2cSJim Jagielski     String              sName;
117*b1cdbd2cSJim Jagielski     Ce_id               nOwner;
118*b1cdbd2cSJim Jagielski     Ce_id               nNameRoom;
119*b1cdbd2cSJim Jagielski 
120*b1cdbd2cSJim Jagielski     Type_id             nType;
121*b1cdbd2cSJim Jagielski     Stereotypes         aStereotypes;
122*b1cdbd2cSJim Jagielski };
123*b1cdbd2cSJim Jagielski 
124*b1cdbd2cSJim Jagielski 
125*b1cdbd2cSJim Jagielski 
126*b1cdbd2cSJim Jagielski 
127*b1cdbd2cSJim Jagielski // IMPLEMENTATION
128*b1cdbd2cSJim Jagielski inline Type_id
Type() const129*b1cdbd2cSJim Jagielski Property::Type() const
130*b1cdbd2cSJim Jagielski {
131*b1cdbd2cSJim Jagielski     return nType;
132*b1cdbd2cSJim Jagielski }
133*b1cdbd2cSJim Jagielski 
134*b1cdbd2cSJim Jagielski 
135*b1cdbd2cSJim Jagielski 
136*b1cdbd2cSJim Jagielski 
137*b1cdbd2cSJim Jagielski }   // namespace idl
138*b1cdbd2cSJim Jagielski }   // namespace ary
139*b1cdbd2cSJim Jagielski #endif
140