Salome HOME
Update from BR_V5_DEV 13Feb2009
[modules/gui.git] / src / SUIT / SUIT_DataObjectKey.h
1 //  Copyright (C) 2007-2008  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.
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 #ifndef SUIT_DATAOBJECTKEY_H
23 #define SUIT_DATAOBJECTKEY_H
24
25 #if _MSC_VER > 1000
26 #pragma once
27 #endif // _MSC_VER > 1000
28
29 #include "SUIT.h"
30
31 class SUIT_EXPORT SUIT_DataObjectKey
32 {
33 public:
34   SUIT_DataObjectKey();
35   virtual ~SUIT_DataObjectKey();
36
37   virtual bool isLess( const SUIT_DataObjectKey* ) const = 0;
38   virtual bool isEqual( const SUIT_DataObjectKey* ) const = 0;
39
40 private:
41   int     refCounter;
42
43   friend class SUIT_DataObjectKeyHandle;
44 };
45
46 class SUIT_EXPORT SUIT_DataObjectKeyHandle
47 {
48 public:
49   SUIT_DataObjectKeyHandle();
50   SUIT_DataObjectKeyHandle( SUIT_DataObjectKey* );
51   SUIT_DataObjectKeyHandle( const SUIT_DataObjectKeyHandle& );
52   ~SUIT_DataObjectKeyHandle();
53
54   void                      nullify();
55   bool                      isNull() const;
56   bool                      operator <( const SUIT_DataObjectKeyHandle& ) const;
57   bool                      operator ==( const SUIT_DataObjectKeyHandle& ) const;
58   SUIT_DataObjectKeyHandle& operator =( const SUIT_DataObjectKeyHandle& );
59
60 private:
61   void                      beginScope();
62   void                      endScope();
63
64 private:
65   SUIT_DataObjectKey*       myKey;
66 };
67
68 #endif