xref: /aoo42x/main/autodoc/inc/ary/idl/i_exception.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_EXCEPTION_HXX
25 #define ARY_IDL_I_EXCEPTION_HXX
26 
27 // BASE CLASSES
28 #include <ary/idl/i_ce.hxx>
29 
30 
31 
32 
33 namespace ary
34 {
35 namespace idl
36 {
37 namespace ifc_exception
38 {
39     struct attr;
40 }
41 
42 
43 /** Represents an IDL exception.
44 */
45 class Exception : public CodeEntity
46 {
47   public:
48     enum E_ClassId { class_id = 2010 };
49 
50     // LIFECYCLE
51                         Exception(
52                             const String &      i_sName,
53                             Ce_id               i_nOwner,
54                             Type_id             i_nBase );
55                         ~Exception();
56     // INQUIRY
Base() const57     Type_id             Base() const            { return nBase; }
58 
59     // ACCESS
60     void                Add_Member(
61                             Ce_id               i_nMember );
62 
63   private:
64     // Interface csv::ConstProcessorClient:
65     virtual void        do_Accept(
66                             csv::ProcessorIfc & io_processor ) const;
67     // Interface ary::Object:
68     virtual ClassId     get_AryClass() const;
69 
70     // Interface CodeEntity
71     virtual const String &  inq_LocalName() const;
72     virtual Ce_id           inq_NameRoom() const;
73     virtual Ce_id           inq_Owner() const;
74     virtual E_SightLevel    inq_SightLevel() const;
75 
76     // Locals
77     typedef std::vector<Ce_id>     ElementList;
78     friend struct ifc_exception::attr;
79 
80     // DATA
81     String              sName;
82     Ce_id               nOwner;
83 
84     Type_id             nBase;
85     ElementList         aElements;
86 };
87 
88 
89 
90 
91 // IMPLEMENTATION
92 inline void
Add_Member(Ce_id i_nMember)93 Exception::Add_Member( Ce_id i_nMember )
94 {
95     aElements.push_back(i_nMember);
96 }
97 
98 
99 
100 
101 }   // namespace idl
102 }   // namespace ary
103 #endif
104