src/HYDROData/HYDROData_VisualState.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_VisualState_HeaderFile
  24 #define HYDROData_VisualState_HeaderFile
  25
  26 #include <HYDROData_Entity.h>
  27
  28 DEFINE_STANDARD_HANDLE(HYDROData_VisualState, HYDROData_Entity)
  29
  30 /**\class HYDROData_VisualState
  31  * \brief Class that stores/retreives information about the visual state.
  32  *
  33  * Keeps the visual state as encoded text string.
  34  */
  35 class HYDROData_VisualState : public HYDROData_Entity
  36 {
  37 protected:
  38   /**
  39    * Enumeration of tags corresponding to the persistent object parameters.
  40    */
  41   enum DataTag
  42   {
  43     DataTag_First = HYDROData_Entity::DataTag_First + 100, ///< first tag, to reserve
  44     DataTag_State ///< encoded visual state
  45   };
  46
  47 public:
  48   DEFINE_STANDARD_RTTI(HYDROData_VisualState);
  49
  50   /**
  51    * Returns the kind of this object. Must be redefined in all objects of known type.
  52    */
  53   HYDRODATA_EXPORT virtual const ObjectKind GetKind() const { return KIND_VISUAL_STATE; }
  54
  55   /**
  56    * Stores the encoded visual state
  57    * \param theState new state
  58    */
  59   HYDRODATA_EXPORT void SetState( const std::string& theState );
  60
  61   /**
  62    * Returns the encoded visual state
  63    */
  64   HYDRODATA_EXPORT std::string GetState() const;
  65
  66 protected:
  67
  68   friend class HYDROData_Iterator;
  69
  70   /**
  71    * Creates new object in the internal data structure. Use higher level objects
  72    * to create objects with real content.
  73    */
  74   HYDROData_VisualState();
  75
  76   /**
  77    * Destructs properties of the object and object itself, removes it from the document.
  78    */
  79   ~HYDROData_VisualState();
  80
  81 };
  82
  83 #endif