0031313: Foundation Classes - Dump improvement for classes
[occt.git] / src / TDataStd / TDataStd_AsciiString.hxx
1 // Created on: 2007-07-31
2 // Created by: Sergey ZARITCHNY
3 // Copyright (c) 2007-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 _TDataStd_AsciiString_HeaderFile
17 #define _TDataStd_AsciiString_HeaderFile
18
19 #include <Standard.hxx>
20 #include <Standard_Type.hxx>
21
22 #include <TCollection_AsciiString.hxx>
23 #include <TDF_Attribute.hxx>
24 #include <Standard_Boolean.hxx>
25 #include <Standard_OStream.hxx>
26 #include <Standard_GUID.hxx>
27
28 class TDF_Label;
29 class TCollection_AsciiString;
30 class TDF_Attribute;
31 class TDF_RelocationTable;
32
33
34 class TDataStd_AsciiString;
35 DEFINE_STANDARD_HANDLE(TDataStd_AsciiString, TDF_Attribute)
36
37 //! Used to define an AsciiString attribute containing a TCollection_AsciiString
38 class TDataStd_AsciiString : public TDF_Attribute
39 {
40
41 public:
42
43   
44   //! class methods
45   //! =============
46   //! Returns the GUID of the attribute.
47   Standard_EXPORT static const Standard_GUID& GetID();
48   
49   //! Finds, or creates an AsciiString attribute and sets the string.
50   //! the AsciiString attribute is returned.
51   //! AsciiString methods
52   //! ===================
53   Standard_EXPORT static Handle(TDataStd_AsciiString) Set (const TDF_Label& label, const TCollection_AsciiString& string);
54  
55   //! Finds, or creates, an AsciiString attribute with explicit user defined <guid> and sets <string>.
56   //! The Name attribute  is  returned. 
57   Standard_EXPORT static Handle(TDataStd_AsciiString) Set (const TDF_Label& label, const Standard_GUID& guid,
58                                     const TCollection_AsciiString& string);
59
60   Standard_EXPORT TDataStd_AsciiString();
61   
62   Standard_EXPORT void Set (const TCollection_AsciiString& S);
63   
64   //! Sets the explicit user defined GUID  to the attribute.
65   Standard_EXPORT void SetID (const Standard_GUID& guid) Standard_OVERRIDE;
66
67   //! Sets default GUID for the attribute.
68   Standard_EXPORT void SetID() Standard_OVERRIDE;
69
70   Standard_EXPORT const TCollection_AsciiString& Get() const;
71   
72   Standard_EXPORT Standard_Boolean IsEmpty() const;
73   
74   Standard_EXPORT const Standard_GUID& ID() const Standard_OVERRIDE;
75   
76   Standard_EXPORT void Restore (const Handle(TDF_Attribute)& with) Standard_OVERRIDE;
77   
78   Standard_EXPORT Handle(TDF_Attribute) NewEmpty() const Standard_OVERRIDE;
79   
80   Standard_EXPORT void Paste (const Handle(TDF_Attribute)& into, const Handle(TDF_RelocationTable)& RT) const Standard_OVERRIDE;
81   
82   Standard_EXPORT virtual Standard_OStream& Dump (Standard_OStream& anOS) const Standard_OVERRIDE;
83
84   //! Dumps the content of me into the stream
85   Standard_EXPORT virtual void DumpJson (Standard_OStream& theOStream, Standard_Integer theDepth = -1) const Standard_OVERRIDE;
86
87
88
89
90   DEFINE_STANDARD_RTTIEXT(TDataStd_AsciiString,TDF_Attribute)
91
92 protected:
93
94
95
96
97 private:
98
99
100   TCollection_AsciiString myString;
101   Standard_GUID myID;
102
103 };
104
105
106
107
108
109
110
111 #endif // _TDataStd_AsciiString_HeaderFile