autodoc/inc/ary/idl/i_exception.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef ARY_IDL_I_EXCEPTION_HXX
  21 #define ARY_IDL_I_EXCEPTION_HXX
  22
  23 // BASE CLASSES
  24 #include <ary/idl/i_ce.hxx>
  25
  26
  27
  28
  29 namespace ary
  30 {
  31 namespace idl
  32 {
  33 namespace ifc_exception
  34 {
  35     struct attr;
  36 }
  37
  38
  39 /** Represents an IDL exception.
  40 */
  41 class Exception : public CodeEntity
  42 {
  43   public:
  44     enum E_ClassId { class_id = 2010 };
  45
  46     // LIFECYCLE
  47                         Exception(
  48                             const String &      i_sName,
  49                             Ce_id               i_nOwner,
  50                             Type_id             i_nBase );
  51                         ~Exception();
  52     // INQUIRY
  53     Type_id             Base() const            { return nBase; }
  54
  55     // ACCESS
  56     void                Add_Member(
  57                             Ce_id               i_nMember );
  58
  59   private:
  60     // Interface csv::ConstProcessorClient:
  61     virtual void        do_Accept(
  62                             csv::ProcessorIfc & io_processor ) const;
  63     // Interface ary::Object:
  64     virtual ClassId     get_AryClass() const;
  65
  66     // Interface CodeEntity
  67     virtual const String &  inq_LocalName() const;
  68     virtual Ce_id           inq_NameRoom() const;
  69     virtual Ce_id           inq_Owner() const;
  70     virtual E_SightLevel    inq_SightLevel() const;
  71
  72     // Locals
  73     typedef std::vector<Ce_id>     ElementList;
  74     friend struct ifc_exception::attr;
  75
  76     // DATA
  77     String              sName;
  78     Ce_id               nOwner;
  79
  80     Type_id             nBase;
  81     ElementList         aElements;
  82 };
  83
  84
  85
  86
  87 // IMPLEMENTATION
  88 inline void
  89 Exception::Add_Member( Ce_id i_nMember )
  90 {
  91     aElements.push_back(i_nMember);
  92 }
  93
  94
  95
  96
  97 }   // namespace idl
  98 }   // namespace ary
  99 #endif
 100
 101 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */