mirror of
https://git.dev.opencascade.org/repos/occt.git
synced 2025-04-21 10:13:43 +03:00
024d6f7775
1. A tool to annotate items in the hierarchical product structure was added. The tool is located under fixed label 0:1:9. It operates two basic entities: notes and annotations located under 0:1:9:1 and 0:1:9:2 hives correspondingly. A note is an attribute derived from base class XCAFDoc_Note that is attached to a separate label under the notes hive. An annotated item is represented by XCAFDoc_AssemblyItemRef attribute attached to a separate label under the annotated items hive. Notes are linked to annotated items by means of XCAFDoc_GraphNode attribute, where notes play parent roles and annotated items - child roles. 2. XCAFDoc_AssemblyItemRef defines a weak reference to a label with optional attribute GUID or sub-shape index. 3. A capability to store note/annotation labels in XCAFDoc_ViewTool was added. 4. XDE User guide was updated
83 lines
2.9 KiB
C++
83 lines
2.9 KiB
C++
// Created on: 2017-02-10
|
|
// Created by: Sergey NIKONOV
|
|
// Copyright (c) 2000-2017 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 _XCAFDoc_Note_HeaderFile
|
|
#define _XCAFDoc_Note_HeaderFile
|
|
|
|
#include <Standard.hxx>
|
|
#include <Standard_Type.hxx>
|
|
#include <TCollection_ExtendedString.hxx>
|
|
#include <OSD_File.hxx>
|
|
#include <TDF_Attribute.hxx>
|
|
#include <TDF_LabelSequence.hxx>
|
|
|
|
class Standard_GUID;
|
|
class TDF_RelocationTable;
|
|
|
|
class XCAFDoc_Note;
|
|
DEFINE_STANDARD_HANDLE(XCAFDoc_Note, TDF_Attribute)
|
|
|
|
//! A base note attribute.
|
|
//! Any note contains the name of the user created the note
|
|
//! and the creation timestamp.
|
|
class XCAFDoc_Note : public TDF_Attribute
|
|
{
|
|
public:
|
|
|
|
DEFINE_STANDARD_RTTIEXT(XCAFDoc_Note, TDF_Attribute)
|
|
|
|
//! Checks if the given label represents a note.
|
|
Standard_EXPORT static Standard_Boolean IsMine(const TDF_Label& theLabel);
|
|
|
|
//! Finds a reference attribute on the given label and returns it, if it is found
|
|
Standard_EXPORT static Handle(XCAFDoc_Note) Get(const TDF_Label& theLabel);
|
|
|
|
//! Sets the user name and the timestamp of the note.
|
|
//! \param [in] theUserName - the user associated with the note.
|
|
//! \param [in] theTimeStamp - timestamp of the note.
|
|
//! \return A handle to the attribute instance.
|
|
Standard_EXPORT void Set(const TCollection_ExtendedString& theUserName,
|
|
const TCollection_ExtendedString& theTimeStamp);
|
|
|
|
//! Returns the user name, who created the note.
|
|
Standard_EXPORT const TCollection_ExtendedString& UserName() const;
|
|
|
|
//! Returns the timestamp of the note.
|
|
Standard_EXPORT const TCollection_ExtendedString& TimeStamp() const;
|
|
|
|
//! Checks if the note isn't linked to annotated items.
|
|
Standard_EXPORT Standard_Boolean IsOrphan() const;
|
|
|
|
public:
|
|
|
|
// Overrides TDF_Attribute virtuals
|
|
Standard_EXPORT void Restore(const Handle(TDF_Attribute)& theAttrFrom) Standard_OVERRIDE;
|
|
Standard_EXPORT void Paste(const Handle(TDF_Attribute)& theAttrInto,
|
|
const Handle(TDF_RelocationTable)& theRT) const Standard_OVERRIDE;
|
|
Standard_EXPORT Standard_OStream& Dump(Standard_OStream& theOS) const Standard_OVERRIDE;
|
|
|
|
protected:
|
|
|
|
//! Creates an empty note.
|
|
Standard_EXPORT XCAFDoc_Note();
|
|
|
|
private:
|
|
|
|
TCollection_ExtendedString myUserName; ///< Name of the user, who created the note.
|
|
TCollection_ExtendedString myTimeStamp; ///< Timestamp, when the note was created.
|
|
};
|
|
|
|
#endif // _XCAFDoc_Note_HeaderFile
|