xref: /aoo4110/main/autodoc/inc/ary/doc/d_docu.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_DOC_D_DOCU_HXX
25*b1cdbd2cSJim Jagielski #define ARY_DOC_D_DOCU_HXX
26*b1cdbd2cSJim Jagielski 
27*b1cdbd2cSJim Jagielski // BASE CLASSES
28*b1cdbd2cSJim Jagielski #include <cosv/tpl/processor.hxx>
29*b1cdbd2cSJim Jagielski 
30*b1cdbd2cSJim Jagielski // USED SERVICES
31*b1cdbd2cSJim Jagielski #include <ary/doc/d_node.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 doc
39*b1cdbd2cSJim Jagielski {
40*b1cdbd2cSJim Jagielski 
41*b1cdbd2cSJim Jagielski 
42*b1cdbd2cSJim Jagielski /** Represents a documentation which is assigned to an Autodoc
43*b1cdbd2cSJim Jagielski     repository entity.
44*b1cdbd2cSJim Jagielski */
45*b1cdbd2cSJim Jagielski class Documentation : public csv::ConstProcessorClient
46*b1cdbd2cSJim Jagielski {
47*b1cdbd2cSJim Jagielski   public:
48*b1cdbd2cSJim Jagielski                         Documentation();
49*b1cdbd2cSJim Jagielski 	                    ~Documentation();
50*b1cdbd2cSJim Jagielski     // OPERATIONS
51*b1cdbd2cSJim Jagielski     void                Clear();
52*b1cdbd2cSJim Jagielski 
53*b1cdbd2cSJim Jagielski     // INQUIRY
54*b1cdbd2cSJim Jagielski     const Node *        Data() const;
55*b1cdbd2cSJim Jagielski 
56*b1cdbd2cSJim Jagielski     // ACCESS
57*b1cdbd2cSJim Jagielski     Node *              Data();
58*b1cdbd2cSJim Jagielski     void                Set_Data(
59*b1cdbd2cSJim Jagielski                             ary::doc::Node &    i_data );
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     // DATA
66*b1cdbd2cSJim Jagielski     Dyn<Node>           pData;
67*b1cdbd2cSJim Jagielski };
68*b1cdbd2cSJim Jagielski 
69*b1cdbd2cSJim Jagielski 
70*b1cdbd2cSJim Jagielski 
71*b1cdbd2cSJim Jagielski 
72*b1cdbd2cSJim Jagielski // IMPLEMENTATION
73*b1cdbd2cSJim Jagielski inline void
Clear()74*b1cdbd2cSJim Jagielski Documentation::Clear()
75*b1cdbd2cSJim Jagielski {
76*b1cdbd2cSJim Jagielski     pData = 0;
77*b1cdbd2cSJim Jagielski }
78*b1cdbd2cSJim Jagielski 
79*b1cdbd2cSJim Jagielski inline const Node *
Data() const80*b1cdbd2cSJim Jagielski Documentation::Data() const
81*b1cdbd2cSJim Jagielski {
82*b1cdbd2cSJim Jagielski     return pData.Ptr();
83*b1cdbd2cSJim Jagielski }
84*b1cdbd2cSJim Jagielski 
85*b1cdbd2cSJim Jagielski inline Node *
Data()86*b1cdbd2cSJim Jagielski Documentation::Data()
87*b1cdbd2cSJim Jagielski {
88*b1cdbd2cSJim Jagielski     return pData.Ptr();
89*b1cdbd2cSJim Jagielski }
90*b1cdbd2cSJim Jagielski 
91*b1cdbd2cSJim Jagielski inline void
Set_Data(ary::doc::Node & i_data)92*b1cdbd2cSJim Jagielski Documentation::Set_Data(ary::doc::Node & i_data)
93*b1cdbd2cSJim Jagielski {
94*b1cdbd2cSJim Jagielski     pData = &i_data;
95*b1cdbd2cSJim Jagielski }
96*b1cdbd2cSJim Jagielski 
97*b1cdbd2cSJim Jagielski 
98*b1cdbd2cSJim Jagielski 
99*b1cdbd2cSJim Jagielski 
100*b1cdbd2cSJim Jagielski }   // namespace doc
101*b1cdbd2cSJim Jagielski }   // namespace ary
102*b1cdbd2cSJim Jagielski #endif
103