src/HYDROGUI/HYDROGUI_PrsDriver.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 HYDROGUI_PRSDRIVER_H
  20 #define HYDROGUI_PRSDRIVER_H
  21
  22 #include <HYDROData_Entity.h>
  23
  24 class HYDROGUI_Prs;
  25
  26 /**
  27  * \class HYDROGUI_PrsDriver
  28  * \brief Base class of presentation driver, which allows to build a
  29  *        presentation on a basis of data object.
  30  */
  31 class HYDROGUI_PrsDriver
  32 {
  33 public:
  34   /**
  35    * \brief Constructor.
  36    */
  37   HYDROGUI_PrsDriver();
  38
  39   /**
  40    * \brief Destructor.
  41    */
  42   virtual ~HYDROGUI_PrsDriver();
  43
  44 public:
  45   /**
  46    * \brief Virtual method intended to update or create the presentation
  47    *        on a basis of data object.
  48    * \param theObj data object
  49    * \param thePrs presentation
  50    * \return status of the operation
  51    */
  52   virtual bool Update( const Handle(HYDROData_Entity)& theObj,
  53                        HYDROGUI_Prs*& thePrs );
  54 };
  55
  56 #endif