0030773: Application Framework - To allow to inherit existing attributes to reuse...
[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 <TDataStd_Real.hxx>
23 #include <Standard_Boolean.hxx>
24 #include <Standard_OStream.hxx>
25 class Standard_GUID;
26 class TDF_Label;
27 class TDF_Attribute;
28 class TDF_RelocationTable;
29
30
31 class XCAFDoc_Volume;
32 DEFINE_STANDARD_HANDLE(XCAFDoc_Volume, TDataStd_Real)
33
34 //! attribute to store volume
35 class XCAFDoc_Volume : public TDataStd_Real
36 {
37
38 public:
39
40   
41   //! class methods
42   //! =============
43   Standard_EXPORT XCAFDoc_Volume();
44   
45   Standard_EXPORT static const Standard_GUID& GetID();
46   
47   Standard_EXPORT const Standard_GUID& ID() const Standard_OVERRIDE;
48   
49   //! Sets a value of volume
50   Standard_EXPORT void Set (const Standard_Real vol);
51   
52   //! Find, or create, an Volume attribute and set its value
53   Standard_EXPORT static Handle(XCAFDoc_Volume) Set (const TDF_Label& label, const Standard_Real vol);
54   
55   Standard_EXPORT Standard_Real Get() const;
56   
57   //! Returns volume as argument
58   //! returns false if no such attribute at the <label>
59   Standard_EXPORT static Standard_Boolean Get (const TDF_Label& label, Standard_Real& vol);
60   
61   Standard_EXPORT virtual Standard_OStream& Dump (Standard_OStream& anOS) const Standard_OVERRIDE;
62
63   //! Dumps the content of me into the stream
64   Standard_EXPORT virtual void DumpJson (Standard_OStream& theOStream, Standard_Integer theDepth = -1) const Standard_OVERRIDE;
65
66
67
68
69   DEFINE_DERIVED_ATTRIBUTE(XCAFDoc_Volume,TDataStd_Real)
70
71 };
72
73
74
75
76
77
78
79 #endif // _XCAFDoc_Volume_HeaderFile