src/HYDROData/HYDROData_NaturalObject.h

   1 // Copyright (C) 2014-2015  EDF-R&D
   2 // This library is free software; you can redistribute it and/or
   3 // modify it under the terms of the GNU Lesser General Public
   4 // License as published by the Free Software Foundation; either
   5 // version 2.1 of the License, or (at your option) any later version.
   6 //
   7 // This library is distributed in the hope that it will be useful,
   8 // but WITHOUT ANY WARRANTY; without even the implied warranty of
   9 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  10 // Lesser General Public License for more details.
  11 //
  12 // You should have received a copy of the GNU Lesser General Public
  13 // License along with this library; if not, write to the Free Software
  14 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  15 //
  16 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  17 //
  18
  19 // modify it under the terms of the GNU Lesser General Public
  20 // License as published by the Free Software Foundation; either
  21 // version 2.1 of the License, or (at your option) any later version.
  22 //
  23 // This library is distributed in the hope that it will be useful,
  24 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  25 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  26 // Lesser General Public License for more details.
  27 //
  28 // You should have received a copy of the GNU Lesser General Public
  29 // License along with this library; if not, write to the Free Software
  30 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  31 //
  32 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  33 //
  34
  35 #ifndef HYDROData_NaturalObject_HeaderFile
  36 #define HYDROData_NaturalObject_HeaderFile
  37
  38 #include <HYDROData_Object.h>
  39
  40 DEFINE_STANDARD_HANDLE(HYDROData_NaturalObject, HYDROData_Object)
  41
  42
  43 /**\class HYDROData_NaturalObject
  44  * \brief The natural objects are objects of environment not created by human.
  45  *
  46  */
  47 class HYDROData_NaturalObject : public HYDROData_Object
  48 {
  49 protected:
  50   /**
  51    * Enumeration of tags corresponding to the persistent object parameters.
  52    */
  53   enum DataTag
  54   {
  55     DataTag_First = HYDROData_Object::DataTag_First + 100 ///< first tag, to reserve
  56   };
  57
  58 public:
  59   DEFINE_STANDARD_RTTI(HYDROData_NaturalObject);
  60
  61 protected:
  62
  63   /**
  64    * Creates new object in the internal data structure. Use higher level objects
  65    * to create objects with real content.
  66    */
  67   HYDRODATA_EXPORT HYDROData_NaturalObject();
  68
  69   /**
  70    * Destructs properties of the object and object itself, removes it from the document.
  71    */
  72   virtual HYDRODATA_EXPORT ~HYDROData_NaturalObject();
  73 };
  74
  75 #endif