xref: /aoo4110/main/autodoc/inc/ary/loc/loc_root.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_PROJECT_HXX
25*b1cdbd2cSJim Jagielski #define ARY_LOC_PROJECT_HXX
26*b1cdbd2cSJim Jagielski 
27*b1cdbd2cSJim Jagielski // BASE CLASSES
28*b1cdbd2cSJim Jagielski #include <ary/loc/loc_le.hxx>
29*b1cdbd2cSJim Jagielski // USED SERVICES
30*b1cdbd2cSJim Jagielski #include <cosv/ploc.hxx>
31*b1cdbd2cSJim Jagielski #include <ary/loc/loc_dir.hxx>
32*b1cdbd2cSJim Jagielski 
33*b1cdbd2cSJim Jagielski 
34*b1cdbd2cSJim Jagielski 
35*b1cdbd2cSJim Jagielski 
36*b1cdbd2cSJim Jagielski namespace ary
37*b1cdbd2cSJim Jagielski {
38*b1cdbd2cSJim Jagielski namespace loc
39*b1cdbd2cSJim Jagielski {
40*b1cdbd2cSJim Jagielski 
41*b1cdbd2cSJim Jagielski 
42*b1cdbd2cSJim Jagielski /** Represents a root directory for source files.
43*b1cdbd2cSJim Jagielski */
44*b1cdbd2cSJim Jagielski class Root : public LocationEntity
45*b1cdbd2cSJim Jagielski {
46*b1cdbd2cSJim Jagielski   public:
47*b1cdbd2cSJim Jagielski     enum E_ClassId { class_id = 7000 };
48*b1cdbd2cSJim Jagielski 
49*b1cdbd2cSJim Jagielski     explicit            Root(
50*b1cdbd2cSJim Jagielski                             const csv::ploc::Path &
51*b1cdbd2cSJim Jagielski                                                 i_rRootDirectoryPath );
52*b1cdbd2cSJim Jagielski     void                Assign_Directory(
53*b1cdbd2cSJim Jagielski                             Le_id               i_assignedDirectory );
54*b1cdbd2cSJim Jagielski     virtual             ~Root();
55*b1cdbd2cSJim Jagielski 
56*b1cdbd2cSJim Jagielski     // INQUIRY
57*b1cdbd2cSJim Jagielski     const csv::ploc::Path &
58*b1cdbd2cSJim Jagielski                         Path() const;
59*b1cdbd2cSJim Jagielski     Le_id               MyDir() const;
60*b1cdbd2cSJim Jagielski 
61*b1cdbd2cSJim Jagielski   private:
62*b1cdbd2cSJim Jagielski     // Interface csv::ConstProcessorClient:
63*b1cdbd2cSJim Jagielski     virtual void        do_Accept(
64*b1cdbd2cSJim Jagielski                             csv::ProcessorIfc & io_processor ) const;
65*b1cdbd2cSJim Jagielski     // Interface ary::Object:
66*b1cdbd2cSJim Jagielski     virtual ClassId     get_AryClass() const;
67*b1cdbd2cSJim Jagielski 
68*b1cdbd2cSJim Jagielski     // Interface LocationEntity:
69*b1cdbd2cSJim Jagielski     virtual const String &
70*b1cdbd2cSJim Jagielski                         inq_LocalName() const;
71*b1cdbd2cSJim Jagielski     virtual Le_id       inq_ParentDirectory() const;
72*b1cdbd2cSJim Jagielski 
73*b1cdbd2cSJim Jagielski 	// DATA
74*b1cdbd2cSJim Jagielski     csv::ploc::Path     aPath;
75*b1cdbd2cSJim Jagielski     String              sPathAsString;
76*b1cdbd2cSJim Jagielski     Le_id               aMyDirectory;
77*b1cdbd2cSJim Jagielski };
78*b1cdbd2cSJim Jagielski 
79*b1cdbd2cSJim Jagielski 
80*b1cdbd2cSJim Jagielski 
81*b1cdbd2cSJim Jagielski 
82*b1cdbd2cSJim Jagielski // IMPLEMENTATION
83*b1cdbd2cSJim Jagielski inline void
Assign_Directory(Le_id i_assignedDirectory)84*b1cdbd2cSJim Jagielski Root::Assign_Directory(Le_id i_assignedDirectory)
85*b1cdbd2cSJim Jagielski {
86*b1cdbd2cSJim Jagielski     aMyDirectory = i_assignedDirectory;
87*b1cdbd2cSJim Jagielski }
88*b1cdbd2cSJim Jagielski 
89*b1cdbd2cSJim Jagielski inline const csv::ploc::Path &
Path() const90*b1cdbd2cSJim Jagielski Root::Path() const
91*b1cdbd2cSJim Jagielski {
92*b1cdbd2cSJim Jagielski     return aPath;
93*b1cdbd2cSJim Jagielski }
94*b1cdbd2cSJim Jagielski 
95*b1cdbd2cSJim Jagielski inline Le_id
MyDir() const96*b1cdbd2cSJim Jagielski Root::MyDir() const
97*b1cdbd2cSJim Jagielski {
98*b1cdbd2cSJim Jagielski     return aMyDirectory;
99*b1cdbd2cSJim Jagielski }
100*b1cdbd2cSJim Jagielski 
101*b1cdbd2cSJim Jagielski 
102*b1cdbd2cSJim Jagielski 
103*b1cdbd2cSJim Jagielski 
104*b1cdbd2cSJim Jagielski } // namespace loc
105*b1cdbd2cSJim Jagielski } // namespace ary
106*b1cdbd2cSJim Jagielski #endif
107