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 #ifndef HYDROData_NaturalObject_HeaderFile
  20 #define HYDROData_NaturalObject_HeaderFile
  21
  22 #include <HYDROData_Object.h>
  23
  24 DEFINE_STANDARD_HANDLE(HYDROData_NaturalObject, HYDROData_Object)
  25
  26
  27 /**\class HYDROData_NaturalObject
  28  * \brief The natural objects are objects of environment not created by human.
  29  *
  30  */
  31 class HYDROData_NaturalObject : public HYDROData_Object
  32 {
  33 protected:
  34   /**
  35    * Enumeration of tags corresponding to the persistent object parameters.
  36    */
  37   enum DataTag
  38   {
  39     DataTag_First = HYDROData_Object::DataTag_First + 100 ///< first tag, to reserve
  40   };
  41
  42 public:
  43   DEFINE_STANDARD_RTTI(HYDROData_NaturalObject);
  44
  45 protected:
  46
  47   /**
  48    * Creates new object in the internal data structure. Use higher level objects
  49    * to create objects with real content.
  50    */
  51   HYDRODATA_EXPORT HYDROData_NaturalObject( Geometry );
  52
  53   /**
  54    * Destructs properties of the object and object itself, removes it from the document.
  55    */
  56   virtual HYDRODATA_EXPORT ~HYDROData_NaturalObject();
  57 };
  58
  59 #endif