include/opencascade/XCAFDoc_Note.hxx

0001 // Copyright (c) 2017-2018 OPEN CASCADE SAS
0002 //
0003 // This file is part of Open CASCADE Technology software library.
0004 //
0005 // This library is free software; you can redistribute it and/or modify it under
0006 // the terms of the GNU Lesser General Public License version 2.1 as published
0007 // by the Free Software Foundation, with special exception defined in the file
0008 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
0009 // distribution for complete text of the license and disclaimer of any warranty.
0010 //
0011 // Alternatively, this file may be used under the terms of Open CASCADE
0012 // commercial license or contractual agreement.
0013
0014 #ifndef _XCAFDoc_Note_HeaderFile
0015 #define _XCAFDoc_Note_HeaderFile
0016
0017 #include <Standard.hxx>
0018 #include <TCollection_ExtendedString.hxx>
0019 #include <TDF_DerivedAttribute.hxx>
0020 #include <TDF_Label.hxx>
0021 #include <NCollection_Sequence.hxx>
0022 #include <XCAFNoteObjects_NoteObject.hxx>
0023
0024 class TDF_RelocationTable;
0025
0026 //! A base note attribute.
0027 //! Any note contains the name of the user created the note
0028 //! and the creation timestamp.
0029 class XCAFDoc_Note : public TDF_Attribute
0030 {
0031 public:
0032   DEFINE_STANDARD_RTTIEXT(XCAFDoc_Note, TDF_Attribute)
0033
0034   //! Checks if the given label represents a note.
0035   Standard_EXPORT static bool IsMine(const TDF_Label& theLabel);
0036
0037   //! Finds a reference attribute on the given label and returns it, if it is found
0038   Standard_EXPORT static occ::handle<XCAFDoc_Note> Get(const TDF_Label& theLabel);
0039
0040   //! Sets the user name and the timestamp of the note.
0041   //! \param[in]  theUserName  - the user associated with the note.
0042   //! \param[in]  theTimeStamp - timestamp of the note.
0043   //! \return A handle to the attribute instance.
0044   Standard_EXPORT void Set(const TCollection_ExtendedString& theUserName,
0045                            const TCollection_ExtendedString& theTimeStamp);
0046
0047   //! Returns the user name, who created the note.
0048   const TCollection_ExtendedString& UserName() const { return myUserName; }
0049
0050   //! Returns the timestamp of the note.
0051   const TCollection_ExtendedString& TimeStamp() const { return myTimeStamp; }
0052
0053   //! Checks if the note isn't linked to annotated items.
0054   Standard_EXPORT bool IsOrphan() const;
0055
0056   //! Returns auxiliary data object
0057   Standard_EXPORT occ::handle<XCAFNoteObjects_NoteObject> GetObject() const;
0058
0059   //! Updates auxiliary data
0060   Standard_EXPORT void SetObject(const occ::handle<XCAFNoteObjects_NoteObject>& theObject);
0061
0062 public:
0063   // Overrides TDF_Attribute virtuals
0064   Standard_EXPORT void              Restore(const occ::handle<TDF_Attribute>& theAttrFrom) override;
0065   Standard_EXPORT void              Paste(const occ::handle<TDF_Attribute>&       theAttrInto,
0066                                           const occ::handle<TDF_RelocationTable>& theRT) const override;
0067   Standard_EXPORT Standard_OStream& Dump(Standard_OStream& theOS) const override;
0068
0069   //! Dumps the content of me into the stream
0070   Standard_EXPORT void DumpJson(Standard_OStream& theOStream, int theDepth = -1) const override;
0071
0072 protected:
0073   //! Creates an empty note.
0074   Standard_EXPORT XCAFDoc_Note();
0075
0076 private:
0077   TCollection_ExtendedString myUserName;  ///< Name of the user, who created the note.
0078   TCollection_ExtendedString myTimeStamp; ///< Timestamp, when the note was created.
0079 };
0080
0081 #endif // _XCAFDoc_Note_HeaderFile