autodoc/inc/ary/entity.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*************************************************************************
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * Copyright 2000, 2010 Oracle and/or its affiliates.
   7  *
   8  * OpenOffice.org - a multi-platform office productivity suite
   9  *
  10  * This file is part of OpenOffice.org.
  11  *
  12  * OpenOffice.org is free software: you can redistribute it and/or modify
  13  * it under the terms of the GNU Lesser General Public License version 3
  14  * only, as published by the Free Software Foundation.
  15  *
  16  * OpenOffice.org is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU Lesser General Public License version 3 for more details
  20  * (a copy is included in the LICENSE file that accompanied this code).
  21  *
  22  * You should have received a copy of the GNU Lesser General Public License
  23  * version 3 along with OpenOffice.org.  If not, see
  24  * <http://www.openoffice.org/license.html>
  25  * for a copy of the LGPLv3 License.
  26  *
  27  ************************************************************************/
  28
  29 #ifndef ARY_ENTITY_HXX
  30 #define ARY_ENTITY_HXX
  31
  32 // BASE CLASSES
  33 #include <ary/object.hxx>
  34
  35
  36
  37
  38 namespace ary
  39 {
  40
  41
  42 /** Interface for every class, whose objects are searchable within the
  43     Autodoc Repository by an id.
  44
  45     @todo
  46     Possibly make ->Set_Id() less public accessible.
  47 */
  48 class Entity : public Object
  49 {
  50   public:
  51     virtual             ~Entity() {}
  52
  53     Rid                 Id() const;
  54
  55     /// @attention Must be used only by ->ary::stg::Storage<>
  56     void                Set_Id(
  57                             Rid                 i_nId );
  58   protected:
  59                         Entity()      : nId(0) {}
  60   private:
  61     // DATA
  62     Rid                 nId;
  63 };
  64
  65
  66 inline Rid
  67 Entity::Id() const
  68 {
  69     return nId;
  70 }
  71
  72 inline void
  73 Entity::Set_Id(Rid i_nId)
  74 {
  75     nId = i_nId;
  76 }
  77
  78
  79
  80
  81 }   // namespace ary
  82 #endif
  83
  84 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */