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