0031313: Foundation Classes - Dump improvement for classes
[occt.git] / src / XCAFDoc / XCAFDoc_Volume.hxx
1 // Created on: 2000-09-08
2 // Created by: data exchange team
3 // Copyright (c) 2000-2014 OPEN CASCADE SAS
4 //
5 // This file is part of Open CASCADE Technology software library.
6 //
7 // This library is free software; you can redistribute it and/or modify it under
8 // the terms of the GNU Lesser General Public License version 2.1 as published
9 // by the Free Software Foundation, with special exception defined in the file
10 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
11 // distribution for complete text of the license and disclaimer of any warranty.
12 //
13 // Alternatively, this file may be used under the terms of Open CASCADE
14 // commercial license or contractual agreement.
15
16 #ifndef _XCAFDoc_Volume_HeaderFile
17 #define _XCAFDoc_Volume_HeaderFile
18
19 #include <Standard.hxx>
20 #include <Standard_Type.hxx>
21
22 #include <Standard_Real.hxx>
23 #include <TDF_Attribute.hxx>
24 #include <Standard_Boolean.hxx>
25 #include <Standard_OStream.hxx>
26 class Standard_GUID;
27 class TDF_Label;
28 class TDF_Attribute;
29 class TDF_RelocationTable;
30
31
32 class XCAFDoc_Volume;
33 DEFINE_STANDARD_HANDLE(XCAFDoc_Volume, TDF_Attribute)
34
35 //! attribute to store volume
36 class XCAFDoc_Volume : public TDF_Attribute
37 {
38
39 public:
40
41   
42   //! class methods
43   //! =============
44   Standard_EXPORT XCAFDoc_Volume();
45   
46   Standard_EXPORT static const Standard_GUID& GetID();
47   
48   Standard_EXPORT const Standard_GUID& ID() const Standard_OVERRIDE;
49   
50   //! Sets a value of volume
51   Standard_EXPORT void Set (const Standard_Real vol);
52   
53   //! Find, or create, an Volume attribute and set its value
54   Standard_EXPORT static Handle(XCAFDoc_Volume) Set (const TDF_Label& label, const Standard_Real vol);
55   
56   Standard_EXPORT Standard_Real Get() const;
57   
58   //! Returns volume as argument
59   //! returns false if no such attribute at the <label>
60   Standard_EXPORT static Standard_Boolean Get (const TDF_Label& label, Standard_Real& vol);
61   
62   Standard_EXPORT void Restore (const Handle(TDF_Attribute)& With) Standard_OVERRIDE;
63   
64   Standard_EXPORT Handle(TDF_Attribute) NewEmpty() const Standard_OVERRIDE;
65   
66   Standard_EXPORT void Paste (const Handle(TDF_Attribute)& Into, const Handle(TDF_RelocationTable)& RT) const Standard_OVERRIDE;
67   
68   Standard_EXPORT virtual Standard_OStream& Dump (Standard_OStream& anOS) const Standard_OVERRIDE;
69
70   //! Dumps the content of me into the stream
71   Standard_EXPORT virtual void DumpJson (Standard_OStream& theOStream, Standard_Integer theDepth = -1) const Standard_OVERRIDE;
72
73
74
75
76   DEFINE_STANDARD_RTTIEXT(XCAFDoc_Volume,TDF_Attribute)
77
78 protected:
79
80
81
82
83 private:
84
85
86   Standard_Real myValue;
87
88
89 };
90
91
92
93
94
95
96
97 #endif // _XCAFDoc_Volume_HeaderFile