0031313: Foundation Classes - Dump improvement for classes
[occt.git] / src / XCAFDoc / XCAFDoc_Datum.hxx
1 // Created on: 2004-01-15
2 // Created by: Sergey KUUL
3 // Copyright (c) 2004-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_Datum_HeaderFile
17 #define _XCAFDoc_Datum_HeaderFile
18
19 #include <Standard.hxx>
20 #include <Standard_Type.hxx>
21
22 #include <TDF_Attribute.hxx>
23 class TCollection_HAsciiString;
24 class Standard_GUID;
25 class TDF_Label;
26 class TDF_Attribute;
27 class TDF_RelocationTable;
28 class XCAFDimTolObjects_DatumObject;
29
30 // resolve name collisions with WinAPI headers
31 #ifdef GetObject
32   #undef GetObject
33 #endif
34
35 class XCAFDoc_Datum;
36 DEFINE_STANDARD_HANDLE(XCAFDoc_Datum, TDF_Attribute)
37
38 //! attribute to store datum
39 class XCAFDoc_Datum : public TDF_Attribute
40 {
41
42 public:
43
44   
45   Standard_EXPORT XCAFDoc_Datum();
46   
47   Standard_EXPORT static const Standard_GUID& GetID();
48   
49   Standard_EXPORT static Handle(XCAFDoc_Datum) Set (const TDF_Label& label, const Handle(TCollection_HAsciiString)& aName, const Handle(TCollection_HAsciiString)& aDescription, const Handle(TCollection_HAsciiString)& anIdentification);
50
51   Standard_EXPORT static   Handle(XCAFDoc_Datum) Set (const TDF_Label& theLabel);
52   
53   Standard_EXPORT void Set (const Handle(TCollection_HAsciiString)& aName, const Handle(TCollection_HAsciiString)& aDescription, const Handle(TCollection_HAsciiString)& anIdentification);
54   
55   Standard_EXPORT Handle(TCollection_HAsciiString) GetName() const;
56   
57   Standard_EXPORT Handle(TCollection_HAsciiString) GetDescription() const;
58   
59   Standard_EXPORT Handle(TCollection_HAsciiString) GetIdentification() const;
60   
61   //! Returns dimension object data taken from the paren's label and its sub-labels.
62   Standard_EXPORT Handle(XCAFDimTolObjects_DatumObject) GetObject() const;
63   
64   //! Updates parent's label and its sub-labels with data taken from theDatumObject.
65   //! Old data associated with the label will be lost.
66   Standard_EXPORT void SetObject(const Handle(XCAFDimTolObjects_DatumObject)& theDatumObject);
67       
68   Standard_EXPORT const Standard_GUID& ID() const Standard_OVERRIDE;
69   
70   Standard_EXPORT void Restore (const Handle(TDF_Attribute)& With) Standard_OVERRIDE;
71   
72   Standard_EXPORT Handle(TDF_Attribute) NewEmpty() const Standard_OVERRIDE;
73   
74   Standard_EXPORT void Paste (const Handle(TDF_Attribute)& Into, const Handle(TDF_RelocationTable)& RT) const Standard_OVERRIDE;
75   
76   //! Dumps the content of me into the stream
77   Standard_EXPORT virtual void DumpJson (Standard_OStream& theOStream, Standard_Integer theDepth = -1) const Standard_OVERRIDE;
78
79   DEFINE_STANDARD_RTTIEXT(XCAFDoc_Datum,TDF_Attribute)
80
81 private:
82
83
84   Handle(TCollection_HAsciiString) myName;
85   Handle(TCollection_HAsciiString) myDescription;
86   Handle(TCollection_HAsciiString) myIdentification;
87
88 };
89
90 #endif // _XCAFDoc_Datum_HeaderFile