xref: /aoo42x/main/autodoc/inc/ary/idl/i_exception.hxx (revision cdf0e10c)
1 /*************************************************************************
2  *
3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4  *
5  * Copyright 2000, 2010 Oracle and/or its affiliates.
6  *
7  * OpenOffice.org - a multi-platform office productivity suite
8  *
9  * This file is part of OpenOffice.org.
10  *
11  * OpenOffice.org is free software: you can redistribute it and/or modify
12  * it under the terms of the GNU Lesser General Public License version 3
13  * only, as published by the Free Software Foundation.
14  *
15  * OpenOffice.org is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18  * GNU Lesser General Public License version 3 for more details
19  * (a copy is included in the LICENSE file that accompanied this code).
20  *
21  * You should have received a copy of the GNU Lesser General Public License
22  * version 3 along with OpenOffice.org.  If not, see
23  * <http://www.openoffice.org/license.html>
24  * for a copy of the LGPLv3 License.
25  *
26  ************************************************************************/
27 
28 #ifndef ARY_IDL_I_EXCEPTION_HXX
29 #define ARY_IDL_I_EXCEPTION_HXX
30 
31 // BASE CLASSES
32 #include <ary/idl/i_ce.hxx>
33 
34 
35 
36 
37 namespace ary
38 {
39 namespace idl
40 {
41 namespace ifc_exception
42 {
43     struct attr;
44 }
45 
46 
47 /** Represents an IDL exception.
48 */
49 class Exception : public CodeEntity
50 {
51   public:
52     enum E_ClassId { class_id = 2010 };
53 
54     // LIFECYCLE
55                         Exception(
56                             const String &      i_sName,
57                             Ce_id               i_nOwner,
58                             Type_id             i_nBase );
59                         ~Exception();
60     // INQUIRY
61     Type_id             Base() const            { return nBase; }
62 
63     // ACCESS
64     void                Add_Member(
65                             Ce_id               i_nMember );
66 
67   private:
68     // Interface csv::ConstProcessorClient:
69     virtual void        do_Accept(
70                             csv::ProcessorIfc & io_processor ) const;
71     // Interface ary::Object:
72     virtual ClassId     get_AryClass() const;
73 
74     // Interface CodeEntity
75     virtual const String &  inq_LocalName() const;
76     virtual Ce_id           inq_NameRoom() const;
77     virtual Ce_id           inq_Owner() const;
78     virtual E_SightLevel    inq_SightLevel() const;
79 
80     // Locals
81     typedef std::vector<Ce_id>     ElementList;
82     friend struct ifc_exception::attr;
83 
84     // DATA
85     String              sName;
86     Ce_id               nOwner;
87 
88     Type_id             nBase;
89     ElementList         aElements;
90 };
91 
92 
93 
94 
95 // IMPLEMENTATION
96 inline void
97 Exception::Add_Member( Ce_id i_nMember )
98 {
99     aElements.push_back(i_nMember);
100 }
101 
102 
103 
104 
105 }   // namespace idl
106 }   // namespace ary
107 #endif
108