src/HYDROData/HYDROData_Digue.h

   1 // Copyright (C) 2007-2015  CEA/DEN, EDF R&D, OPEN CASCADE
   2 //
   3 // Copyright (C) 2003-2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
   4 // CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
   5 //
   6 // This library is free software; you can redistribute it and/or
   7 // modify it under the terms of the GNU Lesser General Public
   8 // License as published by the Free Software Foundation; either
   9 // version 2.1 of the License, or (at your option) any later version.
  10 //
  11 // This library is distributed in the hope that it will be useful,
  12 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 // Lesser General Public License for more details.
  15 //
  16 // You should have received a copy of the GNU Lesser General Public
  17 // License along with this library; if not, write to the Free Software
  18 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  19 //
  20 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  21 //
  22
  23 #ifndef HYDROData_Digue_HeaderFile
  24 #define HYDROData_Digue_HeaderFile
  25
  26 #include "HYDROData_Channel.h"
  27
  28 DEFINE_STANDARD_HANDLE(HYDROData_Digue, HYDROData_Channel)
  29
  30 /**\class HYDROData_Digue
  31  * \brief
  32  *
  33  */
  34 class HYDROData_Digue : public HYDROData_Channel
  35 {
  36 protected:
  37   /**
  38    * Enumeration of tags corresponding to the persistent object parameters.
  39    */
  40   enum DataTag
  41   {
  42     DataTag_First = HYDROData_Channel::DataTag_First + 100, ///< first tag, to reserve
  43   };
  44
  45 public:
  46   DEFINE_STANDARD_RTTI(HYDROData_Digue);
  47
  48   /**
  49    * Returns the kind of this object. Must be redefined in all objects of known type.
  50    */
  51   HYDRODATA_EXPORT virtual const ObjectKind GetKind() const {return KIND_DIGUE;}
  52
  53   /**
  54    * Returns default filling color for new digue.
  55    */
  56   HYDRODATA_EXPORT static QColor DefaultFillingColor();
  57
  58   /**
  59    * Returns default border color for new digue.
  60    */
  61   HYDRODATA_EXPORT static QColor DefaultBorderColor();
  62
  63 protected:
  64
  65   /**
  66    * Returns default filling color for new object.
  67    */
  68   HYDRODATA_EXPORT virtual QColor getDefaultFillingColor() const;
  69
  70   /**
  71    * Returns default border color for new object.
  72    */
  73   HYDRODATA_EXPORT virtual QColor getDefaultBorderColor() const;
  74
  75 protected:
  76
  77   friend class HYDROData_Iterator;
  78
  79   /**
  80    * Creates new object in the internal data structure. Use higher level objects
  81    * to create objects with real content.
  82    */
  83   HYDRODATA_EXPORT HYDROData_Digue();
  84
  85   /**
  86    * Destructs properties of the object and object itself, removes it from the document.
  87    */
  88   virtual HYDRODATA_EXPORT ~HYDROData_Digue();
  89 };
  90
  91 #endif