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