xref: /trunk/main/autodoc/inc/ary/idl/i_comrela.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_IDL_I_COMRELA_HXX
25 #define ARY_IDL_I_COMRELA_HXX
26 
27 // USED SERVICES
28 #include <ary/idl/i_types4idl.hxx>
29 
30 namespace ary
31 {
32 namespace doc
33 {
34     class OldIdlDocu;
35 }
36 }
37 
38 
39 
40 
41 namespace ary
42 {
43 namespace idl
44 {
45 
46 
47 /** Contains data for an IDL code entity related to another one like a base of
48     an interface or of a service or the supported interface of a service.
49 */
50 class CommentedRelation
51 {
52   public:
53     // LIFECYCLE
54 
CommentedRelation(Type_id i_nType,doc::OldIdlDocu * i_pInfo)55                         CommentedRelation(
56                             Type_id             i_nType,
57                             doc::OldIdlDocu *   i_pInfo )
58                                                 :   nType(i_nType),
59                                                     pInfo(i_pInfo)
60                                                 {}
61     // INQUIRY
Type() const62     Type_id             Type() const            { return nType; }
Info() const63     doc::OldIdlDocu *   Info() const            { return pInfo; }
64 
65   private:
66     // DATA
67     Type_id             nType;
68     doc::OldIdlDocu *   pInfo;
69 };
70 
71 
72 
73 
74 }   // namespace idl
75 }   // namespace ary
76 #endif
77