xref: /trunk/main/autodoc/inc/ary/entity.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_ENTITY_HXX
25 #define ARY_ENTITY_HXX
26 
27 // BASE CLASSES
28 #include <ary/object.hxx>
29 
30 
31 
32 
33 namespace ary
34 {
35 
36 
37 /** Interface for every class, whose objects are searchable within the
38     Autodoc Repository by an id.
39 
40     @todo
41     Possibly make ->Set_Id() less public accessible.
42 */
43 class Entity : public Object
44 {
45   public:
~Entity()46     virtual             ~Entity() {}
47 
48     Rid                 Id() const;
49 
50     /// @attention Must be used only by ->ary::stg::Storage<>
51     void                Set_Id(
52                             Rid                 i_nId );
53   protected:
Entity()54                         Entity()      : nId(0) {}
55   private:
56     // DATA
57     Rid                 nId;
58 };
59 
60 
61 inline Rid
Id() const62 Entity::Id() const
63 {
64     return nId;
65 }
66 
67 inline void
Set_Id(Rid i_nId)68 Entity::Set_Id(Rid i_nId)
69 {
70     nId = i_nId;
71 }
72 
73 
74 
75 
76 }   // namespace ary
77 #endif
78