xref: /trunk/main/autodoc/inc/ary/ary.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_ARY_HXX
25 #define ARY_ARY_HXX
26 
27 
28 // USED SERVICES
29 	// BASE CLASSES
30 	// OTHER
31 
32 namespace ary
33 {
34 namespace idl
35 {
36     class Gate;
37 }
38 
39 namespace cpp
40 {
41     class Gate;
42 }
43 }
44 
45 
46 
47 namespace ary
48 {
49 
50 /** Starting point for all work with the
51     Autodoc Sourcecode Repository.
52 
53     Create and destroy the repository and
54     give access to the "Gates" for different tasks.
55 
56     @collab ::ary::cpp::Gate
57     @collab ::ary::idl::Gate
58 */
59 
60 class Repository
61 {
62   public:
63     //  LIFECYCLE
~Repository()64     virtual             ~Repository() {}
65     static DYN Repository &
66                         Create_();
67     // INQUIRY
68     virtual const String &
69                         Title() const = 0;
70     virtual const ::ary::cpp::Gate &
71                         Gate_Cpp() const = 0;
72     virtual const ::ary::idl::Gate &
73                         Gate_Idl() const = 0;
74     // ACCESS
75     virtual ::ary::cpp::Gate &
76                         Gate_Cpp() = 0;
77     virtual ::ary::idl::Gate &
78                         Gate_Idl() = 0;
79     virtual void        Set_Title(
80                             const String &      i_sName ) = 0;
81 };
82 
83 
84 
85 } // namespace ary
86 #endif
87