manes/implementation.h

   1 /* Quarn OS / Manes
   2  *
   3  * Implementation class
   4  *
   5  * Copyright (C) 2008-2009 Pawel Dziepak
   6  *
   7  * This program is free software; you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License as published by
   9  * the Free Software Foundation; either version 2 of the License, or
  10  * (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License along
  18  * with this program; if not, write to the Free Software Foundation, Inc.,
  19  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  */
  22
  23 #ifndef _IMPLEMENTATION_H_
  24 #define _IMPLEMENTATION_H_
  25
  26 #include "ods/obj_ref.h"
  27
  28 #include "libs/pointer.h"
  29
  30 namespace manes {
  31         class component;
  32
  33         /**
  34          * @brief Component implementation base class.
  35          * @details This is the base class for all components and objects
  36          * implementations managed, stored or distributed by
  37          * Managed Execution System.
  38          */
  39         class implementation : public ods::obj_ref {
  40         protected:
  41                 /**
  42                  * @brief Pointer to component object that this class implements.
  43                  * @todo This field has to be made read-only.
  44                  */
  45                 p<component> owner;
  46
  47         public:
  48                 /**
  49                  * @details This method is used only by internal Manes code, while
  50                  * creating instance of this class.
  51                  * @param owner implementation owner
  52                  * @deprecated Client should not have any possibility to
  53                  * change implemetnation owner.
  54                  */
  55                 virtual void set_owner(p<component> owner);
  56
  57                 /**
  58                  * @brief Get component parent.
  59                  * @details This method returns parent of the component that this
  60                  * class implement.
  61                  * @return component parent
  62                  */
  63                 virtual p<component> get_parent();
  64         };
  65 }
  66
  67 #endif
  68