0031939: Coding - correction of spelling errors in comments [part 3]
[occt.git] / src / Transfer / Transfer_TransientMapper.hxx
1 // Created on: 1992-02-03
2 // Created by: Christian CAILLET
3 // Copyright (c) 1992-1999 Matra Datavision
4 // Copyright (c) 1999-2014 OPEN CASCADE SAS
5 //
6 // This file is part of Open CASCADE Technology software library.
7 //
8 // This library is free software; you can redistribute it and/or modify it under
9 // the terms of the GNU Lesser General Public License version 2.1 as published
10 // by the Free Software Foundation, with special exception defined in the file
11 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
12 // distribution for complete text of the license and disclaimer of any warranty.
13 //
14 // Alternatively, this file may be used under the terms of Open CASCADE
15 // commercial license or contractual agreement.
16
17 #ifndef _Transfer_TransientMapper_HeaderFile
18 #define _Transfer_TransientMapper_HeaderFile
19
20 #include <Standard.hxx>
21 #include <Standard_Type.hxx>
22
23 #include <Transfer_Finder.hxx>
24 #include <TColStd_MapTransientHasher.hxx>
25 #include <Standard_Boolean.hxx>
26 #include <Standard_Type.hxx>
27 #include <Standard_CString.hxx>
28 class Standard_Transient;
29 class Transfer_DataInfo;
30 class Transfer_Finder;
31
32
33 class Transfer_TransientMapper;
34 DEFINE_STANDARD_HANDLE(Transfer_TransientMapper, Transfer_Finder)
35
36
37 class Transfer_TransientMapper : public Transfer_Finder
38 {
39
40 public:
41
42   
43   //! Creates a Mapper with a Value. This Value can then not be
44   //! changed. It is used by the Hasher to compute the HashCode,
45   //! which will then be stored for an immediate reading.
46   Standard_EXPORT Transfer_TransientMapper(const Handle(Standard_Transient)& akey);
47   
48   //! Returns the contained value
49   Standard_EXPORT const Handle(Standard_Transient)& Value() const;
50   
51   //! Specific testof equality : defined as False if <other> has
52   //! not the same true Type, else contents are compared (by
53   //! C++ operator ==)
54   Standard_EXPORT Standard_Boolean Equates (const Handle(Transfer_Finder)& other) const Standard_OVERRIDE;
55   
56   //! Returns the Type of the Value. By default, returns the
57   //! DynamicType of <me>, but can be redefined
58   Standard_EXPORT virtual Handle(Standard_Type) ValueType() const Standard_OVERRIDE;
59   
60   //! Returns the name of the Type of the Value. Default is name
61   //! of ValueType, unless it is for a non-handled object
62   Standard_EXPORT virtual Standard_CString ValueTypeName() const Standard_OVERRIDE;
63
64
65
66
67   DEFINE_STANDARD_RTTI_INLINE(Transfer_TransientMapper,Transfer_Finder)
68
69 protected:
70
71
72
73
74 private:
75
76
77   Handle(Standard_Transient) theval;
78
79
80 };
81
82
83
84
85
86
87
88 #endif // _Transfer_TransientMapper_HeaderFile