xref: /aoo4110/main/autodoc/inc/ary/idl/i_ce2s.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_IDL_I_CE2S_HXX
25*b1cdbd2cSJim Jagielski #define ARY_IDL_I_CE2S_HXX
26*b1cdbd2cSJim Jagielski 
27*b1cdbd2cSJim Jagielski 
28*b1cdbd2cSJim Jagielski // USED SERVICES
29*b1cdbd2cSJim Jagielski     // BASE CLASSES
30*b1cdbd2cSJim Jagielski     // COMPONENTS
31*b1cdbd2cSJim Jagielski     // PARAMETERS
32*b1cdbd2cSJim Jagielski #include <ary/idl/i_types4idl.hxx>
33*b1cdbd2cSJim Jagielski 
34*b1cdbd2cSJim Jagielski 
35*b1cdbd2cSJim Jagielski namespace ary
36*b1cdbd2cSJim Jagielski {
37*b1cdbd2cSJim Jagielski 
38*b1cdbd2cSJim Jagielski namespace idl
39*b1cdbd2cSJim Jagielski {
40*b1cdbd2cSJim Jagielski 
41*b1cdbd2cSJim Jagielski 
42*b1cdbd2cSJim Jagielski 
43*b1cdbd2cSJim Jagielski /** Abstract base for all secondary productions of code entities
44*b1cdbd2cSJim Jagielski */
45*b1cdbd2cSJim Jagielski class Ce_2s
46*b1cdbd2cSJim Jagielski {
47*b1cdbd2cSJim Jagielski   public:
48*b1cdbd2cSJim Jagielski     // LIFECYCLE
Ce_2s()49*b1cdbd2cSJim Jagielski     explicit Ce_2s () { }
50*b1cdbd2cSJim Jagielski     virtual             ~Ce_2s();
51*b1cdbd2cSJim Jagielski 
52*b1cdbd2cSJim Jagielski     static DYN Ce_2s *  Create_(
53*b1cdbd2cSJim Jagielski                             ClassId             i_nCeClass );
54*b1cdbd2cSJim Jagielski     // OPERATIONS
Add_Link2DescriptionInManual(const String & i_link,const String & i_linkUI)55*b1cdbd2cSJim Jagielski     void                Add_Link2DescriptionInManual(
56*b1cdbd2cSJim Jagielski                             const String &      i_link,
57*b1cdbd2cSJim Jagielski                             const String &      i_linkUI )
58*b1cdbd2cSJim Jagielski                                                 { aDescriptionsInManual.push_back(i_link); aDescriptionsInManual.push_back(i_linkUI); }
Add_Link2RefInManual(const String & i_link,const String & i_linkUI)59*b1cdbd2cSJim Jagielski     void                Add_Link2RefInManual(
60*b1cdbd2cSJim Jagielski                             const String &      i_link,
61*b1cdbd2cSJim Jagielski                             const String &      i_linkUI )
62*b1cdbd2cSJim Jagielski                                                 { aRefsInManual.push_back(i_link); aRefsInManual.push_back(i_linkUI); }
63*b1cdbd2cSJim Jagielski     std::vector<Ce_id> &
64*b1cdbd2cSJim Jagielski                         Access_List(
65*b1cdbd2cSJim Jagielski                             int                 i_indexOfList );
66*b1cdbd2cSJim Jagielski     // INQUIRY
67*b1cdbd2cSJim Jagielski     const StringVector &
Links2DescriptionInManual() const68*b1cdbd2cSJim Jagielski                         Links2DescriptionInManual() const
69*b1cdbd2cSJim Jagielski                                                 { return aDescriptionsInManual; }
70*b1cdbd2cSJim Jagielski     const StringVector &
Links2RefsInManual() const71*b1cdbd2cSJim Jagielski                         Links2RefsInManual() const
72*b1cdbd2cSJim Jagielski                                                 { return aRefsInManual; }
CountXrefLists() const73*b1cdbd2cSJim Jagielski     int                 CountXrefLists() const  { return aXrefLists.size(); }
74*b1cdbd2cSJim Jagielski     const std::vector<Ce_id> &
75*b1cdbd2cSJim Jagielski                         List(
76*b1cdbd2cSJim Jagielski                             int                 i_indexOfList ) const;
77*b1cdbd2cSJim Jagielski   private:
78*b1cdbd2cSJim Jagielski     typedef DYN std::vector<Ce_id> * ListPtr;
79*b1cdbd2cSJim Jagielski 
80*b1cdbd2cSJim Jagielski     // DATA
81*b1cdbd2cSJim Jagielski     StringVector        aDescriptionsInManual;
82*b1cdbd2cSJim Jagielski     StringVector        aRefsInManual;
83*b1cdbd2cSJim Jagielski     std::vector<ListPtr>
84*b1cdbd2cSJim Jagielski                         aXrefLists;
85*b1cdbd2cSJim Jagielski };
86*b1cdbd2cSJim Jagielski 
87*b1cdbd2cSJim Jagielski 
88*b1cdbd2cSJim Jagielski 
89*b1cdbd2cSJim Jagielski 
90*b1cdbd2cSJim Jagielski }   // namespace idl
91*b1cdbd2cSJim Jagielski }   // namespace ary
92*b1cdbd2cSJim Jagielski #endif
93