include/opencascade/TDataStd_AsciiString.hxx

0001 // Created on: 2007-07-31
0002 // Created by: Sergey ZARITCHNY
0003 // Copyright (c) 2007-2014 OPEN CASCADE SAS
0004 //
0005 // This file is part of Open CASCADE Technology software library.
0006 //
0007 // This library is free software; you can redistribute it and/or modify it under
0008 // the terms of the GNU Lesser General Public License version 2.1 as published
0009 // by the Free Software Foundation, with special exception defined in the file
0010 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
0011 // distribution for complete text of the license and disclaimer of any warranty.
0012 //
0013 // Alternatively, this file may be used under the terms of Open CASCADE
0014 // commercial license or contractual agreement.
0015
0016 #ifndef _TDataStd_AsciiString_HeaderFile
0017 #define _TDataStd_AsciiString_HeaderFile
0018
0019 #include <Standard.hxx>
0020
0021 #include <TCollection_AsciiString.hxx>
0022 #include <TDF_Attribute.hxx>
0023 #include <Standard_OStream.hxx>
0024 #include <Standard_GUID.hxx>
0025
0026 class TDF_Label;
0027 class TDF_RelocationTable;
0028
0029
0030 class TDataStd_AsciiString;
0031 DEFINE_STANDARD_HANDLE(TDataStd_AsciiString, TDF_Attribute)
0032
0033 //! Used to define an AsciiString attribute containing a TCollection_AsciiString
0034 class TDataStd_AsciiString : public TDF_Attribute
0035 {
0036
0037 public:
0038
0039
0040   //! class methods
0041   //! =============
0042   //! Returns the GUID of the attribute.
0043   Standard_EXPORT static const Standard_GUID& GetID();
0044
0045   //! Finds, or creates an AsciiString attribute and sets the string.
0046   //! the AsciiString attribute is returned.
0047   //! AsciiString methods
0048   //! ===================
0049   Standard_EXPORT static Handle(TDataStd_AsciiString) Set (const TDF_Label& label, const TCollection_AsciiString& string);
0050
0051   //! Finds, or creates, an AsciiString attribute with explicit user defined <guid> and sets <string>.
0052   //! The Name attribute  is  returned.
0053   Standard_EXPORT static Handle(TDataStd_AsciiString) Set (const TDF_Label& label, const Standard_GUID& guid,
0054                                 const TCollection_AsciiString& string);
0055
0056   Standard_EXPORT TDataStd_AsciiString();
0057
0058   Standard_EXPORT void Set (const TCollection_AsciiString& S);
0059
0060   //! Sets the explicit user defined GUID  to the attribute.
0061   Standard_EXPORT void SetID (const Standard_GUID& guid) Standard_OVERRIDE;
0062
0063   //! Sets default GUID for the attribute.
0064   Standard_EXPORT void SetID() Standard_OVERRIDE;
0065
0066   Standard_EXPORT const TCollection_AsciiString& Get() const;
0067
0068   Standard_EXPORT Standard_Boolean IsEmpty() const;
0069
0070   Standard_EXPORT const Standard_GUID& ID() const Standard_OVERRIDE;
0071
0072   Standard_EXPORT void Restore (const Handle(TDF_Attribute)& with) Standard_OVERRIDE;
0073
0074   Standard_EXPORT Handle(TDF_Attribute) NewEmpty() const Standard_OVERRIDE;
0075
0076   Standard_EXPORT void Paste (const Handle(TDF_Attribute)& into, const Handle(TDF_RelocationTable)& RT) const Standard_OVERRIDE;
0077
0078   Standard_EXPORT virtual Standard_OStream& Dump (Standard_OStream& anOS) const Standard_OVERRIDE;
0079
0080   //! Dumps the content of me into the stream
0081   Standard_EXPORT virtual void DumpJson (Standard_OStream& theOStream, Standard_Integer theDepth = -1) const Standard_OVERRIDE;
0082
0083
0084
0085
0086   DEFINE_STANDARD_RTTIEXT(TDataStd_AsciiString,TDF_Attribute)
0087
0088 protected:
0089
0090
0091
0092
0093 private:
0094
0095
0096   TCollection_AsciiString myString;
0097   Standard_GUID myID;
0098
0099 };
0100
0101
0102
0103
0104
0105
0106
0107 #endif // _TDataStd_AsciiString_HeaderFile