0031313: Foundation Classes - Dump improvement for classes
[occt.git] / src / TDataStd / TDataStd_Comment.hxx
1 // Created on: 1998-01-15
2 // Created by: Denis PASCAL
3 // Copyright (c) 1998-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 _TDataStd_Comment_HeaderFile
18 #define _TDataStd_Comment_HeaderFile
19
20 #include <Standard.hxx>
21 #include <Standard_Type.hxx>
22
23 #include <TCollection_ExtendedString.hxx>
24 #include <TDF_Attribute.hxx>
25 #include <Standard_OStream.hxx>
26 #include <Standard_Boolean.hxx>
27 class Standard_GUID;
28 class TDF_Label;
29 class TCollection_ExtendedString;
30 class TDF_Attribute;
31 class TDF_RelocationTable;
32
33
34 class TDataStd_Comment;
35 DEFINE_STANDARD_HANDLE(TDataStd_Comment, TDF_Attribute)
36
37 //! Comment attribute. may be  associated to any label
38 //! to store user comment.
39 class TDataStd_Comment : public TDF_Attribute
40 {
41
42 public:
43
44   
45   //! class methods
46   //! =============
47   //! Returns the GUID for comments.
48   Standard_EXPORT static const Standard_GUID& GetID();
49   
50   //! Find, or create  a   Comment attribute.  the  Comment
51   //! attribute is returned.
52   Standard_EXPORT static Handle(TDataStd_Comment) Set (const TDF_Label& label);
53   
54   //! Finds, or creates a Comment attribute and sets the string.
55   //! the Comment attribute is returned.
56   //! Comment methods
57   //! ============
58   Standard_EXPORT static Handle(TDataStd_Comment) Set (const TDF_Label& label, const TCollection_ExtendedString& string);
59   
60   Standard_EXPORT TDataStd_Comment();
61   
62   Standard_EXPORT void Set (const TCollection_ExtendedString& S);
63   
64
65   //! Returns the comment attribute.
66   Standard_EXPORT const TCollection_ExtendedString& Get() const;
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   Standard_EXPORT virtual Standard_OStream& Dump (Standard_OStream& anOS) const Standard_OVERRIDE;
77   
78   Standard_EXPORT Standard_Boolean AfterRetrieval (const Standard_Boolean forceIt = Standard_False) Standard_OVERRIDE;
79   
80   //! Dumps the content of me into the stream
81   Standard_EXPORT virtual void DumpJson (Standard_OStream& theOStream, Standard_Integer theDepth = -1) const Standard_OVERRIDE;
82
83
84
85
86   DEFINE_STANDARD_RTTIEXT(TDataStd_Comment,TDF_Attribute)
87
88 protected:
89
90
91
92
93 private:
94
95
96   TCollection_ExtendedString myString;
97
98
99 };
100
101
102
103
104
105
106
107 #endif // _TDataStd_Comment_HeaderFile