OCCT

// Created on: 1998-01-15
// Created by: Denis PASCAL
// Copyright (c) 1998-1999 Matra Datavision
// Copyright (c) 1999-2014 OPEN CASCADE SAS
//
// This file is part of Open CASCADE Technology software library.
//
// This library is free software; you can redistribute it and/or modify it under
// the terms of the GNU Lesser General Public License version 2.1 as published
// by the Free Software Foundation, with special exception defined in the file
// OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
// distribution for complete text of the license and disclaimer of any warranty.
//
// Alternatively, this file may be used under the terms of Open CASCADE
// commercial license or contractual agreement.

#ifndef _TDataStd_Comment_HeaderFile
#define _TDataStd_Comment_HeaderFile

#include <TDataStd_GenericExtString.hxx>

//! Comment attribute. may be associated to any label
//! to store user comment.
class TDataStd_Comment : public TDataStd_GenericExtString
{

public:
  //! class methods
  //! =============
  //! Returns the GUID for comments.
  Standard_EXPORT static const Standard_GUID& GetID();

  //! Find, or create a Comment attribute. the Comment
  //! attribute is returned.
  Standard_EXPORT static occ::handle<TDataStd_Comment> Set(const TDF_Label& label);

  //! Finds, or creates a Comment attribute and sets the string.
  //! the Comment attribute is returned.
  //! Comment methods
  //! ============
  Standard_EXPORT static occ::handle<TDataStd_Comment> Set(
    const TDF_Label&                  label,
    const TCollection_ExtendedString& string);

  Standard_EXPORT TDataStd_Comment();

  Standard_EXPORT void Set(const TCollection_ExtendedString& S) override;

  //! Sets the explicit user defined GUID to the attribute.
  Standard_EXPORT void SetID(const Standard_GUID& guid) override;

  //! Sets default GUID for the attribute.
  Standard_EXPORT void SetID() override;

  Standard_EXPORT Standard_OStream& Dump(Standard_OStream& anOS) const override;

  DEFINE_DERIVED_ATTRIBUTE(TDataStd_Comment, TDataStd_GenericExtString)
};

#endif // _TDataStd_Comment_HeaderFile