xref: /aoo4110/main/autodoc/inc/ary/loc/loc_le.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_LOC_LE_HXX
25*b1cdbd2cSJim Jagielski #define ARY_LOC_LE_HXX
26*b1cdbd2cSJim Jagielski 
27*b1cdbd2cSJim Jagielski // USED SERVICES
28*b1cdbd2cSJim Jagielski 	// BASE CLASSES
29*b1cdbd2cSJim Jagielski #include <ary/entity.hxx>
30*b1cdbd2cSJim Jagielski 	// COMPONENTS
31*b1cdbd2cSJim Jagielski 	// PARAMETERS
32*b1cdbd2cSJim Jagielski #include <ary/loc/loc_types4loc.hxx>
33*b1cdbd2cSJim Jagielski #include <ary/loc/loc_traits.hxx>
34*b1cdbd2cSJim Jagielski 
35*b1cdbd2cSJim Jagielski 
36*b1cdbd2cSJim Jagielski 
37*b1cdbd2cSJim Jagielski namespace ary
38*b1cdbd2cSJim Jagielski {
39*b1cdbd2cSJim Jagielski namespace loc
40*b1cdbd2cSJim Jagielski {
41*b1cdbd2cSJim Jagielski 
42*b1cdbd2cSJim Jagielski 
43*b1cdbd2cSJim Jagielski /** Base class for all file locations in the Autodoc repository.
44*b1cdbd2cSJim Jagielski */
45*b1cdbd2cSJim Jagielski class LocationEntity : public ::ary::Entity
46*b1cdbd2cSJim Jagielski {
47*b1cdbd2cSJim Jagielski   public:
48*b1cdbd2cSJim Jagielski     typedef Le_Traits       traits_t;
49*b1cdbd2cSJim Jagielski 
~LocationEntity()50*b1cdbd2cSJim Jagielski     virtual             ~LocationEntity() {}
51*b1cdbd2cSJim Jagielski 
52*b1cdbd2cSJim Jagielski     Le_id               LeId() const;
53*b1cdbd2cSJim Jagielski     const String &      LocalName() const;
54*b1cdbd2cSJim Jagielski     Le_id               ParentDirectory() const;
55*b1cdbd2cSJim Jagielski 
56*b1cdbd2cSJim Jagielski   private:
57*b1cdbd2cSJim Jagielski     virtual const String &
58*b1cdbd2cSJim Jagielski                         inq_LocalName() const = 0;
59*b1cdbd2cSJim Jagielski     virtual Le_id       inq_ParentDirectory() const = 0;
60*b1cdbd2cSJim Jagielski };
61*b1cdbd2cSJim Jagielski 
62*b1cdbd2cSJim Jagielski 
63*b1cdbd2cSJim Jagielski 
64*b1cdbd2cSJim Jagielski 
65*b1cdbd2cSJim Jagielski // IMPLEMENTATION
66*b1cdbd2cSJim Jagielski inline Le_id
LeId() const67*b1cdbd2cSJim Jagielski LocationEntity::LeId() const
68*b1cdbd2cSJim Jagielski {
69*b1cdbd2cSJim Jagielski     return TypedId<LocationEntity>(Id());
70*b1cdbd2cSJim Jagielski }
71*b1cdbd2cSJim Jagielski 
72*b1cdbd2cSJim Jagielski inline const String &
LocalName() const73*b1cdbd2cSJim Jagielski LocationEntity::LocalName() const
74*b1cdbd2cSJim Jagielski {
75*b1cdbd2cSJim Jagielski     return inq_LocalName();
76*b1cdbd2cSJim Jagielski }
77*b1cdbd2cSJim Jagielski 
78*b1cdbd2cSJim Jagielski inline Le_id
ParentDirectory() const79*b1cdbd2cSJim Jagielski LocationEntity::ParentDirectory() const
80*b1cdbd2cSJim Jagielski {
81*b1cdbd2cSJim Jagielski     return inq_ParentDirectory();
82*b1cdbd2cSJim Jagielski }
83*b1cdbd2cSJim Jagielski 
84*b1cdbd2cSJim Jagielski 
85*b1cdbd2cSJim Jagielski 
86*b1cdbd2cSJim Jagielski 
87*b1cdbd2cSJim Jagielski 
88*b1cdbd2cSJim Jagielski } // namespace loc
89*b1cdbd2cSJim Jagielski } // namespace ary
90*b1cdbd2cSJim Jagielski #endif
91