1 // Created on: 2007-07-31
2 // Created by: Sergey ZARITCHNY
3 // Copyright (c) 2007-2014 OPEN CASCADE SAS
5 // This file is part of Open CASCADE Technology software library.
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.
13 // Alternatively, this file may be used under the terms of Open CASCADE
14 // commercial license or contractual agreement.
16 #ifndef _TDataStd_AsciiString_HeaderFile
17 #define _TDataStd_AsciiString_HeaderFile
19 #include <Standard.hxx>
21 #include <TCollection_AsciiString.hxx>
22 #include <TDF_Attribute.hxx>
23 #include <Standard_OStream.hxx>
24 #include <Standard_GUID.hxx>
27 class TDF_RelocationTable;
30 class TDataStd_AsciiString;
31 DEFINE_STANDARD_HANDLE(TDataStd_AsciiString, TDF_Attribute)
33 //! Used to define an AsciiString attribute containing a TCollection_AsciiString
34 class TDataStd_AsciiString : public TDF_Attribute
42 //! Returns the GUID of the attribute.
43 Standard_EXPORT static const Standard_GUID& GetID();
45 //! Finds, or creates an AsciiString attribute and sets the string.
46 //! the AsciiString attribute is returned.
47 //! AsciiString methods
48 //! ===================
49 Standard_EXPORT static Handle(TDataStd_AsciiString) Set (const TDF_Label& label, const TCollection_AsciiString& string);
51 //! Finds, or creates, an AsciiString attribute with explicit user defined <guid> and sets <string>.
52 //! The Name attribute is returned.
53 Standard_EXPORT static Handle(TDataStd_AsciiString) Set (const TDF_Label& label, const Standard_GUID& guid,
54 const TCollection_AsciiString& string);
56 Standard_EXPORT TDataStd_AsciiString();
58 Standard_EXPORT void Set (const TCollection_AsciiString& S);
60 //! Sets the explicit user defined GUID to the attribute.
61 Standard_EXPORT void SetID (const Standard_GUID& guid) Standard_OVERRIDE;
63 //! Sets default GUID for the attribute.
64 Standard_EXPORT void SetID() Standard_OVERRIDE;
66 Standard_EXPORT const TCollection_AsciiString& Get() const;
68 Standard_EXPORT Standard_Boolean IsEmpty() const;
70 Standard_EXPORT const Standard_GUID& ID() const Standard_OVERRIDE;
72 Standard_EXPORT void Restore (const Handle(TDF_Attribute)& with) Standard_OVERRIDE;
74 Standard_EXPORT Handle(TDF_Attribute) NewEmpty() const Standard_OVERRIDE;
76 Standard_EXPORT void Paste (const Handle(TDF_Attribute)& into, const Handle(TDF_RelocationTable)& RT) const Standard_OVERRIDE;
78 Standard_EXPORT virtual Standard_OStream& Dump (Standard_OStream& anOS) const Standard_OVERRIDE;
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;
86 DEFINE_STANDARD_RTTIEXT(TDataStd_AsciiString,TDF_Attribute)
96 TCollection_AsciiString myString;
107 #endif // _TDataStd_AsciiString_HeaderFile