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_CE_HXX 25*b1cdbd2cSJim Jagielski #define ARY_IDL_I_CE_HXX 26*b1cdbd2cSJim Jagielski 27*b1cdbd2cSJim Jagielski // BASE CLASSES 28*b1cdbd2cSJim Jagielski #include <ary/entity.hxx> 29*b1cdbd2cSJim Jagielski // USED SERVICES 30*b1cdbd2cSJim Jagielski #include <ary/doc/d_docu.hxx> 31*b1cdbd2cSJim Jagielski #include <ary/idl/i_ce2s.hxx> 32*b1cdbd2cSJim Jagielski #include <ary/idl/i_types4idl.hxx> 33*b1cdbd2cSJim Jagielski 34*b1cdbd2cSJim Jagielski 35*b1cdbd2cSJim Jagielski 36*b1cdbd2cSJim Jagielski 37*b1cdbd2cSJim Jagielski 38*b1cdbd2cSJim Jagielski 39*b1cdbd2cSJim Jagielski namespace ary 40*b1cdbd2cSJim Jagielski { 41*b1cdbd2cSJim Jagielski namespace idl 42*b1cdbd2cSJim Jagielski { 43*b1cdbd2cSJim Jagielski 44*b1cdbd2cSJim Jagielski 45*b1cdbd2cSJim Jagielski /** @resp Base class for all IDL code entities. 46*b1cdbd2cSJim Jagielski 47*b1cdbd2cSJim Jagielski A @->CodeEntity is a namespace, type, data or function, which occures in 48*b1cdbd2cSJim Jagielski the parsed UNO IDL code and is described and/or commented within the 49*b1cdbd2cSJim Jagielski Autodoc repository. 50*b1cdbd2cSJim Jagielski 51*b1cdbd2cSJim Jagielski This is a storage base class, where more special classes are 52*b1cdbd2cSJim Jagielski derived from. 53*b1cdbd2cSJim Jagielski */ 54*b1cdbd2cSJim Jagielski class CodeEntity : public ary::Entity 55*b1cdbd2cSJim Jagielski { 56*b1cdbd2cSJim Jagielski public: 57*b1cdbd2cSJim Jagielski // LIFECYCLE 58*b1cdbd2cSJim Jagielski virtual ~CodeEntity(); 59*b1cdbd2cSJim Jagielski 60*b1cdbd2cSJim Jagielski // OPERATION 61*b1cdbd2cSJim Jagielski 62*b1cdbd2cSJim Jagielski // INQUIRY CeId() const63*b1cdbd2cSJim Jagielski Ce_id CeId() const { return Ce_id(Id()); } 64*b1cdbd2cSJim Jagielski const String & LocalName() const; 65*b1cdbd2cSJim Jagielski Ce_id NameRoom() const; 66*b1cdbd2cSJim Jagielski Ce_id Owner() const; 67*b1cdbd2cSJim Jagielski E_SightLevel SightLevel() const; 68*b1cdbd2cSJim Jagielski 69*b1cdbd2cSJim Jagielski const ary::doc::Documentation & 70*b1cdbd2cSJim Jagielski Docu() const; 71*b1cdbd2cSJim Jagielski const Ce_2s & Secondaries() const; 72*b1cdbd2cSJim Jagielski 73*b1cdbd2cSJim Jagielski static const CodeEntity & 74*b1cdbd2cSJim Jagielski Null_(); 75*b1cdbd2cSJim Jagielski // ACCESS 76*b1cdbd2cSJim Jagielski void Set_Docu( 77*b1cdbd2cSJim Jagielski DYN ary::doc::Node & 78*b1cdbd2cSJim Jagielski pass_data ); 79*b1cdbd2cSJim Jagielski Ce_2s & Secondaries(); 80*b1cdbd2cSJim Jagielski 81*b1cdbd2cSJim Jagielski protected: 82*b1cdbd2cSJim Jagielski CodeEntity(); 83*b1cdbd2cSJim Jagielski private: 84*b1cdbd2cSJim Jagielski // Locals 85*b1cdbd2cSJim Jagielski virtual const String & inq_LocalName() const = 0; 86*b1cdbd2cSJim Jagielski virtual Ce_id inq_NameRoom() const = 0; 87*b1cdbd2cSJim Jagielski virtual Ce_id inq_Owner() const = 0; 88*b1cdbd2cSJim Jagielski virtual E_SightLevel inq_SightLevel() const = 0; 89*b1cdbd2cSJim Jagielski 90*b1cdbd2cSJim Jagielski // DATA 91*b1cdbd2cSJim Jagielski ary::doc::Documentation 92*b1cdbd2cSJim Jagielski aDocu; 93*b1cdbd2cSJim Jagielski Dyn<Ce_2s> p2s; 94*b1cdbd2cSJim Jagielski }; 95*b1cdbd2cSJim Jagielski 96*b1cdbd2cSJim Jagielski 97*b1cdbd2cSJim Jagielski 98*b1cdbd2cSJim Jagielski 99*b1cdbd2cSJim Jagielski // IMPLEMENTATION 100*b1cdbd2cSJim Jagielski inline const String & LocalName() const101*b1cdbd2cSJim JagielskiCodeEntity::LocalName() const 102*b1cdbd2cSJim Jagielski { return inq_LocalName(); } 103*b1cdbd2cSJim Jagielski 104*b1cdbd2cSJim Jagielski inline Ce_id NameRoom() const105*b1cdbd2cSJim JagielskiCodeEntity::NameRoom() const 106*b1cdbd2cSJim Jagielski { return inq_NameRoom(); } 107*b1cdbd2cSJim Jagielski 108*b1cdbd2cSJim Jagielski inline Ce_id Owner() const109*b1cdbd2cSJim JagielskiCodeEntity::Owner() const 110*b1cdbd2cSJim Jagielski { return inq_Owner(); } 111*b1cdbd2cSJim Jagielski 112*b1cdbd2cSJim Jagielski inline E_SightLevel SightLevel() const113*b1cdbd2cSJim JagielskiCodeEntity::SightLevel() const 114*b1cdbd2cSJim Jagielski { return inq_SightLevel(); } 115*b1cdbd2cSJim Jagielski 116*b1cdbd2cSJim Jagielski inline const ary::doc::Documentation & Docu() const117*b1cdbd2cSJim JagielskiCodeEntity::Docu() const 118*b1cdbd2cSJim Jagielski { return aDocu; } 119*b1cdbd2cSJim Jagielski 120*b1cdbd2cSJim Jagielski inline void Set_Docu(DYN ary::doc::Node & pass_data)121*b1cdbd2cSJim JagielskiCodeEntity::Set_Docu(DYN ary::doc::Node & pass_data) 122*b1cdbd2cSJim Jagielski { 123*b1cdbd2cSJim Jagielski aDocu.Set_Data(pass_data); 124*b1cdbd2cSJim Jagielski } 125*b1cdbd2cSJim Jagielski 126*b1cdbd2cSJim Jagielski 127*b1cdbd2cSJim Jagielski 128*b1cdbd2cSJim Jagielski 129*b1cdbd2cSJim Jagielski } // namespace idl 130*b1cdbd2cSJim Jagielski } // namespace ary 131*b1cdbd2cSJim Jagielski #endif 132