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