include/opencascade/TDataStd_Comment.hxx

0001 // Created on: 1998-01-15
0002 // Created by: Denis PASCAL
0003 // Copyright (c) 1998-1999 Matra Datavision
0004 // Copyright (c) 1999-2014 OPEN CASCADE SAS
0005 //
0006 // This file is part of Open CASCADE Technology software library.
0007 //
0008 // This library is free software; you can redistribute it and/or modify it under
0009 // the terms of the GNU Lesser General Public License version 2.1 as published
0010 // by the Free Software Foundation, with special exception defined in the file
0011 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
0012 // distribution for complete text of the license and disclaimer of any warranty.
0013 //
0014 // Alternatively, this file may be used under the terms of Open CASCADE
0015 // commercial license or contractual agreement.
0016
0017 #ifndef _TDataStd_Comment_HeaderFile
0018 #define _TDataStd_Comment_HeaderFile
0019
0020 #include <TDataStd_GenericExtString.hxx>
0021
0022 class TDataStd_Comment;
0023 DEFINE_STANDARD_HANDLE(TDataStd_Comment, TDataStd_GenericExtString)
0024
0025 //! Comment attribute. may be  associated to any label
0026 //! to store user comment.
0027 class TDataStd_Comment : public TDataStd_GenericExtString
0028 {
0029
0030 public:
0031   //! class methods
0032   //! =============
0033   //! Returns the GUID for comments.
0034   Standard_EXPORT static const Standard_GUID& GetID();
0035
0036   //! Find, or create  a   Comment attribute.  the  Comment
0037   //! attribute is returned.
0038   Standard_EXPORT static Handle(TDataStd_Comment) Set(const TDF_Label& label);
0039
0040   //! Finds, or creates a Comment attribute and sets the string.
0041   //! the Comment attribute is returned.
0042   //! Comment methods
0043   //! ============
0044   Standard_EXPORT static Handle(TDataStd_Comment) Set(const TDF_Label&                  label,
0045                                                       const TCollection_ExtendedString& string);
0046
0047   Standard_EXPORT TDataStd_Comment();
0048
0049   Standard_EXPORT void Set(const TCollection_ExtendedString& S) Standard_OVERRIDE;
0050
0051   //! Sets the explicit user defined GUID  to the attribute.
0052   Standard_EXPORT void SetID(const Standard_GUID& guid) Standard_OVERRIDE;
0053
0054   //! Sets default GUID for the attribute.
0055   Standard_EXPORT void SetID() Standard_OVERRIDE;
0056
0057   Standard_EXPORT virtual Standard_OStream& Dump(Standard_OStream& anOS) const Standard_OVERRIDE;
0058
0059   DEFINE_DERIVED_ATTRIBUTE(TDataStd_Comment, TDataStd_GenericExtString)
0060 };
0061
0062 #endif // _TDataStd_Comment_HeaderFile