xref: /aoo41x/main/autodoc/inc/ary/entity.hxx (revision 1c78a5d6)
1*1c78a5d6SAndrew Rist /**************************************************************
2cdf0e10cSrcweir  *
3*1c78a5d6SAndrew Rist  * Licensed to the Apache Software Foundation (ASF) under one
4*1c78a5d6SAndrew Rist  * or more contributor license agreements.  See the NOTICE file
5*1c78a5d6SAndrew Rist  * distributed with this work for additional information
6*1c78a5d6SAndrew Rist  * regarding copyright ownership.  The ASF licenses this file
7*1c78a5d6SAndrew Rist  * to you under the Apache License, Version 2.0 (the
8*1c78a5d6SAndrew Rist  * "License"); you may not use this file except in compliance
9*1c78a5d6SAndrew Rist  * with the License.  You may obtain a copy of the License at
10*1c78a5d6SAndrew Rist  *
11*1c78a5d6SAndrew Rist  *   http://www.apache.org/licenses/LICENSE-2.0
12*1c78a5d6SAndrew Rist  *
13*1c78a5d6SAndrew Rist  * Unless required by applicable law or agreed to in writing,
14*1c78a5d6SAndrew Rist  * software distributed under the License is distributed on an
15*1c78a5d6SAndrew Rist  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16*1c78a5d6SAndrew Rist  * KIND, either express or implied.  See the License for the
17*1c78a5d6SAndrew Rist  * specific language governing permissions and limitations
18*1c78a5d6SAndrew Rist  * under the License.
19*1c78a5d6SAndrew Rist  *
20*1c78a5d6SAndrew Rist  *************************************************************/
21*1c78a5d6SAndrew Rist 
22*1c78a5d6SAndrew Rist 
23cdf0e10cSrcweir 
24cdf0e10cSrcweir #ifndef ARY_ENTITY_HXX
25cdf0e10cSrcweir #define ARY_ENTITY_HXX
26cdf0e10cSrcweir 
27cdf0e10cSrcweir // BASE CLASSES
28cdf0e10cSrcweir #include <ary/object.hxx>
29cdf0e10cSrcweir 
30cdf0e10cSrcweir 
31cdf0e10cSrcweir 
32cdf0e10cSrcweir 
33cdf0e10cSrcweir namespace ary
34cdf0e10cSrcweir {
35cdf0e10cSrcweir 
36cdf0e10cSrcweir 
37cdf0e10cSrcweir /** Interface for every class, whose objects are searchable within the
38cdf0e10cSrcweir     Autodoc Repository by an id.
39cdf0e10cSrcweir 
40cdf0e10cSrcweir     @todo
41cdf0e10cSrcweir     Possibly make ->Set_Id() less public accessible.
42cdf0e10cSrcweir */
43cdf0e10cSrcweir class Entity : public Object
44cdf0e10cSrcweir {
45cdf0e10cSrcweir   public:
~Entity()46cdf0e10cSrcweir     virtual             ~Entity() {}
47cdf0e10cSrcweir 
48cdf0e10cSrcweir     Rid                 Id() const;
49cdf0e10cSrcweir 
50cdf0e10cSrcweir     /// @attention Must be used only by ->ary::stg::Storage<>
51cdf0e10cSrcweir     void                Set_Id(
52cdf0e10cSrcweir                             Rid                 i_nId );
53cdf0e10cSrcweir   protected:
Entity()54cdf0e10cSrcweir                         Entity()      : nId(0) {}
55cdf0e10cSrcweir   private:
56cdf0e10cSrcweir     // DATA
57cdf0e10cSrcweir     Rid                 nId;
58cdf0e10cSrcweir };
59cdf0e10cSrcweir 
60cdf0e10cSrcweir 
61cdf0e10cSrcweir inline Rid
Id() const62cdf0e10cSrcweir Entity::Id() const
63cdf0e10cSrcweir {
64cdf0e10cSrcweir     return nId;
65cdf0e10cSrcweir }
66cdf0e10cSrcweir 
67cdf0e10cSrcweir inline void
Set_Id(Rid i_nId)68cdf0e10cSrcweir Entity::Set_Id(Rid i_nId)
69cdf0e10cSrcweir {
70cdf0e10cSrcweir     nId = i_nId;
71cdf0e10cSrcweir }
72cdf0e10cSrcweir 
73cdf0e10cSrcweir 
74cdf0e10cSrcweir 
75cdf0e10cSrcweir 
76cdf0e10cSrcweir }   // namespace ary
77cdf0e10cSrcweir #endif
78