A tool to annotate items in the hierarchical product structure. There are two basic entities, which operates the notes tool: notes and annotated items. A note is a user defined data structure derived from XCAFDoc_Note attribute 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 with annotated items by means of XCAFDoc_GraphNode attribute. Notes play parent roles and annotated items - child roles. More...

#include <XCAFDoc_NotesTool.hxx>

Inheritance diagram for XCAFDoc_NotesTool:

[legend]

Public Member Functions
	XCAFDoc_NotesTool ()
	Creates an empty notes tool. More...

TDF_Label	GetNotesLabel () const
	Returns the label of the notes hive. More...

TDF_Label	GetAnnotatedItemsLabel () const
	Returns the label of the annotated items hive. More...

Standard_Integer	NbNotes () const
	Returns the number of labels in the notes hive. More...

Standard_Integer	NbAnnotatedItems () const
	Returns the number of labels in the annotated items hive. More...

void	GetNotes (TDF_LabelSequence &theNoteLabels) const
	Returns all labels from the notes hive. The label sequence isn't cleared beforehand. More...

void	GetAnnotatedItems (TDF_LabelSequence &theLabels) const
	Returns all labels from the annotated items hive. The label sequence isn't cleared beforehand. More...

Standard_Boolean	IsAnnotatedItem (const XCAFDoc_AssemblyItemId &theItemId) const
	Checks if the given assembly item is annotated. More...

Standard_Boolean	IsAnnotatedItem (const TDF_Label &theItemLabel) const
	Checks if the given labeled item is annotated. More...

const Standard_GUID &	ID () const override
	Returns the ID of the attribute. More...

Standard_OStream &	Dump (Standard_OStream &theOS) const override
	Dumps the minimum information about <me> on <aStream>. More...

Find annotated item functions
TDF_Label	FindAnnotatedItem (const XCAFDoc_AssemblyItemId &theItemId) const
	Finds a label of the given assembly item ID in the annotated items hive. More...

TDF_Label	FindAnnotatedItem (const TDF_Label &theItemLabel) const
	Finds a label of the given labeled item in the annotated items hive. More...

TDF_Label	FindAnnotatedItemAttr (const XCAFDoc_AssemblyItemId &theItemId, const Standard_GUID &theGUID) const
	Finds a label of the given assembly item's attribute in the annotated items hive. More...

TDF_Label	FindAnnotatedItemAttr (const TDF_Label &theItemLabel, const Standard_GUID &theGUID) const
	Finds a label of the given labeled item's attribute in the annotated items hive. More...

TDF_Label	FindAnnotatedItemSubshape (const XCAFDoc_AssemblyItemId &theItemId, Standard_Integer theSubshapeIndex) const
	Finds a label of the given assembly item's subshape in the annotated items hive. More...

TDF_Label	FindAnnotatedItemSubshape (const TDF_Label &theItemLabel, Standard_Integer theSubshapeIndex) const
	Finds a label of the given labeled item's subshape in the annotated items hive. More...

Note creation functions
Handle< XCAFDoc_Note >	CreateComment (const TCollection_ExtendedString &theUserName, const TCollection_ExtendedString &theTimeStamp, const TCollection_ExtendedString &theComment)
	Create a new comment note. Creates a new label under the notes hive and attaches XCAFDoc_NoteComment attribute (derived ftom XCAFDoc_Note). More...

Handle< XCAFDoc_Note >	CreateBalloon (const TCollection_ExtendedString &theUserName, const TCollection_ExtendedString &theTimeStamp, const TCollection_ExtendedString &theComment)
	Create a new 'balloon' note. Creates a new label under the notes hive and attaches XCAFDoc_NoteBalloon attribute (derived ftom XCAFDoc_Note). More...

Handle< XCAFDoc_Note >	CreateBinData (const TCollection_ExtendedString &theUserName, const TCollection_ExtendedString &theTimeStamp, const TCollection_ExtendedString &theTitle, const TCollection_AsciiString &theMIMEtype, OSD_File &theFile)
	Create a new note with data loaded from a binary file. Creates a new label under the notes hive and attaches XCAFDoc_NoteComment attribute (derived ftom XCAFDoc_Note). More...

Handle< XCAFDoc_Note >	CreateBinData (const TCollection_ExtendedString &theUserName, const TCollection_ExtendedString &theTimeStamp, const TCollection_ExtendedString &theTitle, const TCollection_AsciiString &theMIMEtype, const Handle< TColStd_HArray1OfByte > &theData)
	Create a new note with data loaded from a byte data array. Creates a new label under the notes hive and attaches XCAFDoc_NoteComment attribute (derived ftom XCAFDoc_Note). More...

Get notes from annotated items functions
Standard_Integer	GetNotes (const XCAFDoc_AssemblyItemId &theItemId, TDF_LabelSequence &theNoteLabels) const
	Gets all note labels of the assembly item. Notes linked to item's subshapes or attributes aren't taken into account. The label sequence isn't cleared beforehand. More...

Standard_Integer	GetNotes (const TDF_Label &theItemLabel, TDF_LabelSequence &theNoteLabels) const
	Gets all note labels of the labeled item. Notes linked to item's attributes aren't taken into account. The label sequence isn't cleared beforehand. More...

Standard_Integer	GetAttrNotes (const XCAFDoc_AssemblyItemId &theItemId, const Standard_GUID &theGUID, TDF_LabelSequence &theNoteLabels) const
	Gets all note labels of the assembly item's attribute. Notes linked to the item itself or to item's subshapes aren't taken into account. The label sequence isn't cleared beforehand. More...

Standard_Integer	GetAttrNotes (const TDF_Label &theItemLabel, const Standard_GUID &theGUID, TDF_LabelSequence &theNoteLabels) const
	Gets all note labels of the labeled item's attribute. Notes linked to the item itself or to item's subshapes aren't taken into account. The label sequence isn't cleared beforehand. More...

Standard_Integer	GetSubshapeNotes (const XCAFDoc_AssemblyItemId &theItemId, Standard_Integer theSubshapeIndex, TDF_LabelSequence &theNoteLabels) const
	Gets all note labels of the annotated item. Notes linked to the item itself or to item's attributes taken into account. The label sequence isn't cleared beforehand. More...

Annotation functions
Handle< XCAFDoc_AssemblyItemRef >	AddNote (const TDF_Label &theNoteLabel, const XCAFDoc_AssemblyItemId &theItemId)
	Adds the given note to the assembly item. More...

Handle< XCAFDoc_AssemblyItemRef >	AddNote (const TDF_Label &theNoteLabel, const TDF_Label &theItemLabel)
	Adds the given note to the labeled item. More...

Handle< XCAFDoc_AssemblyItemRef >	AddNoteToAttr (const TDF_Label &theNoteLabel, const XCAFDoc_AssemblyItemId &theItemId, const Standard_GUID &theGUID)
	Adds the given note to the assembly item's attribute. More...

Handle< XCAFDoc_AssemblyItemRef >	AddNoteToAttr (const TDF_Label &theNoteLabel, const TDF_Label &theItemLabel, const Standard_GUID &theGUID)
	Adds the given note to the labeled item's attribute. More...

Handle< XCAFDoc_AssemblyItemRef >	AddNoteToSubshape (const TDF_Label &theNoteLabel, const XCAFDoc_AssemblyItemId &theItemId, Standard_Integer theSubshapeIndex)
	Adds the given note to the assembly item's subshape. More...

Handle< XCAFDoc_AssemblyItemRef >	AddNoteToSubshape (const TDF_Label &theNoteLabel, const TDF_Label &theItemLabel, Standard_Integer theSubshapeIndex)
	Adds the given note to the labeled item's subshape. More...

Remove annotation functions
Standard_Boolean	RemoveNote (const TDF_Label &theNoteLabel, const XCAFDoc_AssemblyItemId &theItemId, Standard_Boolean theDelIfOrphan=Standard_False)
	Removes the given note from the assembly item. More...

Standard_Boolean	RemoveNote (const TDF_Label &theNoteLabel, const TDF_Label &theItemLabel, Standard_Boolean theDelIfOrphan=Standard_False)
	Removes the given note from the labeled item. More...

Standard_Boolean	RemoveSubshapeNote (const TDF_Label &theNoteLabel, const XCAFDoc_AssemblyItemId &theItemId, Standard_Integer theSubshapeIndex, Standard_Boolean theDelIfOrphan=Standard_False)
	Removes the given note from the assembly item's subshape. More...

Standard_Boolean	RemoveSubshapeNote (const TDF_Label &theNoteLabel, const TDF_Label &theItemLabel, Standard_Integer theSubshapeIndex, Standard_Boolean theDelIfOrphan=Standard_False)
	Removes the given note from the labeled item's subshape. More...

Standard_Boolean	RemoveAttrNote (const TDF_Label &theNoteLabel, const XCAFDoc_AssemblyItemId &theItemId, const Standard_GUID &theGUID, Standard_Boolean theDelIfOrphan=Standard_False)
	Removes a note from the assembly item's attribute. More...

Standard_Boolean	RemoveAttrNote (const TDF_Label &theNoteLabel, const TDF_Label &theItemLabel, const Standard_GUID &theGUID, Standard_Boolean theDelIfOrphan=Standard_False)
	Removes a note from the labeled item's attribute. More...

Standard_Boolean	RemoveAllNotes (const XCAFDoc_AssemblyItemId &theItemId, Standard_Boolean theDelIfOrphan=Standard_False)
	Removes all notes from the assembly item. More...

Standard_Boolean	RemoveAllNotes (const TDF_Label &theItemLabel, Standard_Boolean theDelIfOrphan=Standard_False)
	Removes all notes from the labeled item. More...

Standard_Boolean	RemoveAllSubshapeNotes (const XCAFDoc_AssemblyItemId &theItemId, Standard_Integer theSubshapeIndex, Standard_Boolean theDelIfOrphan=Standard_False)
	Removes all notes from the assembly item's subshape. More...

Standard_Boolean	RemoveAllAttrNotes (const XCAFDoc_AssemblyItemId &theItemId, const Standard_GUID &theGUID, Standard_Boolean theDelIfOrphan=Standard_False)
	Removes all notes from the assembly item's attribute. More...

Standard_Boolean	RemoveAllAttrNotes (const TDF_Label &theItemLabel, const Standard_GUID &theGUID, Standard_Boolean theDelIfOrphan=Standard_False)
	Removes all notes from the labeled item's attribute. More...

Delete note functions
Standard_Boolean	DeleteNote (const TDF_Label &theNoteLabel)
	Deletes the given note. Removes all links with items annotated by the note. More...

Standard_Integer	DeleteNotes (TDF_LabelSequence &theNoteLabels)
	Deletes the given notes. Removes all links with items annotated by the notes. More...

Standard_Integer	DeleteAllNotes ()
	Deletes all notes. Clears all annotations. More...

Orphan annotated items functions
Standard_Integer	NbOrphanNotes () const
	Returns number of notes that aren't linked to annotated items. More...

void	GetOrphanNotes (TDF_LabelSequence &theNoteLabels) const
	Returns note labels that aren't linked to annotated items. The label sequence isn't cleared beforehand. More...

Standard_Integer	DeleteOrphanNotes ()
	Deletes all notes that aren't linked to annotated items. More...

Public Member Functions inherited from TDataStd_GenericEmpty
void	Restore (const Handle< TDF_Attribute > &) override
	Restores the backuped contents from <anAttribute> into this one. It is used when aborting a transaction. More...

void	Paste (const Handle< TDF_Attribute > &, const Handle< TDF_RelocationTable > &) const override
	This method is different from the "Copy" one, because it is used when copying an attribute from a source structure into a target structure. This method may paste the contents of <me> into <intoAttribute>. More...

virtual void	DumpJson (Standard_OStream &theOStream, Standard_Integer theDepth=-1) const override
	Dumps the content of me into the stream. More...

Public Member Functions inherited from TDF_Attribute
virtual void	SetID (const Standard_GUID &)
	Sets specific ID of the attribute (supports several attributes of one type at the same label feature). More...

virtual void	SetID ()
	Sets default ID defined in nested class (to be used for attributes having User ID feature). More...

const TDF_Label	Label () const
	Returns the label to which the attribute is attached. If the label is not included in a DF, the label is null. See Label. Warning If the label is not included in a data framework, it is null. This function should not be redefined inline. More...

Standard_Integer	Transaction () const
	Returns the transaction index in which the attribute has been created or modified. More...

Standard_Integer	UntilTransaction () const
	Returns the upper transaction index until which the attribute is/was valid. This number may vary. A removed attribute validity range is reduced to its transaction index. More...

Standard_Boolean	IsValid () const
	Returns true if the attribute is valid; i.e. not a backuped or removed one. More...

Standard_Boolean	IsNew () const
	Returns true if the attribute has no backup. More...

Standard_Boolean	IsForgotten () const
	Returns true if the attribute forgotten status is set. More...

Standard_Boolean	IsAttribute (const Standard_GUID &anID) const
	Returns true if it exists an associated attribute of <me> with <anID> as ID. More...

Standard_Boolean	FindAttribute (const Standard_GUID &anID, Handle< TDF_Attribute > &anAttribute) const
	Finds an associated attribute of <me>, according to <anID>. the returned <anAttribute> is a valid one. The method returns True if found, False otherwise. A removed attribute cannot be found using this method. More...

template<class T >
Standard_Boolean	FindAttribute (const Standard_GUID &theID, Handle< T > &theAttr) const
	Safe variant for arbitrary type of argument. More...

void	AddAttribute (const Handle< TDF_Attribute > &other) const
	Adds an Attribute <other> to the label of <me>.Raises if there is already one of the same GUID fhan <other>. More...

Standard_Boolean	ForgetAttribute (const Standard_GUID &aguid) const
	Forgets the Attribute of GUID <aguid> associated to the label of <me>. Be careful that if <me> is the attribute of <guid>, <me> will have a null label after this call. If the attribute doesn't exist returns False. Otherwise returns True. More...

void	ForgetAllAttributes (const Standard_Boolean clearChildren=Standard_True) const
	Forgets all the attributes attached to the label of <me>. Does it on the sub-labels if <clearChildren> is set to true. Of course, this method is compatible with Transaction & Delta mechanisms. Be careful that if <me> will have a null label after this call. More...

virtual void	AfterAddition ()
	Something to do after adding an Attribute to a label. More...

virtual void	BeforeRemoval ()
	Something to do before removing an Attribute from a label. More...

virtual void	BeforeForget ()
	Something to do before forgetting an Attribute to a label. More...

virtual void	AfterResume ()
	Something to do after resuming an Attribute from a label. More...

virtual Standard_Boolean	AfterRetrieval (const Standard_Boolean forceIt=Standard_False)
	Something to do AFTER creation of an attribute by persistent-transient translation. The returned status says if AfterUndo has been performed (true) or if this callback must be called once again further (false). If <forceIt> is set to true, the method MUST perform and return true. Does nothing by default and returns true. More...

virtual Standard_Boolean	BeforeUndo (const Handle< TDF_AttributeDelta > &anAttDelta, const Standard_Boolean forceIt=Standard_False)
	Something to do before applying <anAttDelta>. The returned status says if AfterUndo has been performed (true) or if this callback must be called once again further (false). If <forceIt> is set to true, the method MUST perform and return true. Does nothing by default and returns true. More...

virtual Standard_Boolean	AfterUndo (const Handle< TDF_AttributeDelta > &anAttDelta, const Standard_Boolean forceIt=Standard_False)
	Something to do after applying <anAttDelta>. The returned status says if AfterUndo has been performed (true) or if this callback must be called once again further (false). If <forceIt> is set to true, the method MUST perform and return true. Does nothing by default and returns true. More...

virtual void	BeforeCommitTransaction ()
	A callback. By default does nothing. It is called by TDF_Data::CommitTransaction() method. More...

void	Backup ()
	Backups the attribute. The backuped attribute is flagged "Backuped" and not "Valid". More...

Standard_Boolean	IsBackuped () const
	Returns true if the attribute backup status is set. This status is set/unset by the Backup() method. More...

virtual Handle< TDF_Attribute >	BackupCopy () const
	Copies the attribute contents into a new other attribute. It is used by Backup(). More...

virtual Handle< TDF_DeltaOnAddition >	DeltaOnAddition () const
	Makes an AttributeDelta because <me> appeared. The only known use of a redefinition of this method is to return a null handle (no delta). More...

virtual Handle< TDF_DeltaOnForget >	DeltaOnForget () const
	Makes an AttributeDelta because <me> has been forgotten. More...

virtual Handle< TDF_DeltaOnResume >	DeltaOnResume () const
	Makes an AttributeDelta because <me> has been resumed. More...

virtual Handle< TDF_DeltaOnModification >	DeltaOnModification (const Handle< TDF_Attribute > &anOldAttribute) const
	Makes a DeltaOnModification between <me> and <anOldAttribute. More...

virtual void	DeltaOnModification (const Handle< TDF_DeltaOnModification > &aDelta)
	Applies a DeltaOnModification to <me>. More...

virtual Handle< TDF_DeltaOnRemoval >	DeltaOnRemoval () const
	Makes a DeltaOnRemoval on <me> because <me> has disappeared from the DS. More...

virtual Handle< TDF_Attribute >	NewEmpty () const =0
	Returns an new empty attribute from the good end type. It is used by the copy algorithm. More...

virtual void	References (const Handle< TDF_DataSet > &aDataSet) const
	Adds the first level referenced attributes and labels to <aDataSet>. More...

Standard_OStream &	operator<< (Standard_OStream &anOS) const

virtual void	ExtendedDump (Standard_OStream &anOS, const TDF_IDFilter &aFilter, TDF_AttributeIndexedMap &aMap) const
	Dumps the attribute content on <aStream>, using <aMap> like this: if an attribute is not in the map, first put add it to the map and then dump it. Use the map rank instead of dumping each attribute field. More...

void	Forget (const Standard_Integer aTransaction)
	Forgets the attribute. <aTransaction> is the current transaction in which the forget is done. A forgotten attribute is also flagged not "Valid". More...

Public Member Functions inherited from Standard_Transient
	Standard_Transient ()
	Empty constructor. More...

	Standard_Transient (const Standard_Transient &)
	Copy constructor – does nothing. More...

Standard_Transient &	operator= (const Standard_Transient &)
	Assignment operator, needed to avoid copying reference counter. More...

virtual	~Standard_Transient ()
	Destructor must be virtual. More...

virtual void	Delete () const
	Memory deallocator for transient classes. More...

virtual const opencascade::handle< Standard_Type > &	DynamicType () const
	Returns a type descriptor about this object. More...

Standard_Boolean	IsInstance (const opencascade::handle< Standard_Type > &theType) const
	Returns a true value if this is an instance of Type. More...

Standard_Boolean	IsInstance (const Standard_CString theTypeName) const
	Returns a true value if this is an instance of TypeName. More...

Standard_Boolean	IsKind (const opencascade::handle< Standard_Type > &theType) const
	Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism. More...

Standard_Boolean	IsKind (const Standard_CString theTypeName) const
	Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism. More...

Standard_Transient *	This () const
	Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero. More...

Standard_Integer	GetRefCount () const
	Get the reference counter of this object. More...

void	IncrementRefCounter () const
	Increments the reference counter of this object. More...

Standard_Integer	DecrementRefCounter () const
	Decrements the reference counter of this object; returns the decremented value. More...

Static Public Member Functions
static const Standard_GUID &	GetID ()
	Returns default attribute GUID. More...

static Handle< XCAFDoc_NotesTool >	Set (const TDF_Label &theLabel)
	Create (if not exist) a notes tool from XCAFDoc on theLabel. More...

Static Public Member Functions inherited from Standard_Transient
static const char *	get_type_name ()
	Returns a type descriptor about this object. More...

static const opencascade::handle< Standard_Type > &	get_type_descriptor ()
	Returns type descriptor of Standard_Transient class. More...

Additional Inherited Members
Public Types inherited from Standard_Transient
typedef void	base_type
	Returns a type descriptor about this object. More...

Protected Member Functions inherited from TDF_Attribute
	TDF_Attribute ()
	Initializes fields. More...

Detailed Description

A tool to annotate items in the hierarchical product structure. There are two basic entities, which operates the notes tool: notes and annotated items. A note is a user defined data structure derived from XCAFDoc_Note attribute 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 with annotated items by means of XCAFDoc_GraphNode attribute. Notes play parent roles and annotated items - child roles.

| XCAFDoc_DocumentTool |

| 0:1 |

|1

| XCAFDoc_NotesTool |

| 0:1:9 |

|1 | ----------------— ------------------------— +___| Notes |--—| XCAFDoc_Note | | 1| 0:1:9:1 |1 *| 0:1:9:1:* | | ----------------— ------------------------— | !* | { XCAFDoc_GraphNode } | ! | ----------------— ------------------------— +___| Annotated items |--—| XCAFDoc_AssemblyItemRef | 1| 0:1:9:2 |1 *| 0:1:9:2: |

A typical annotation procedure is illustrated by the code example below:

 {.c++}
// Get the notes tool from a XCAF document
Handle(XCAFDoc_NotesTool) aNotesTool = XCAFDoc_DocumentTool::NotesTool(aDoc->Main());
// Create new comment note
Handle(XCAFDoc_Note) aNote = aNotesTool->CreateComment(aUserName, aTimestamp, aComment);
if (!aNote.IsNull()) {
  Handle(XCAFDoc_AssemblyItemRef) aRef = aNotesTool->AddNote(aNote->Label(), anAssemblyItemId);
  if (aRef.IsNull()) {
    // Process error...
  }
}

Constructor & Destructor Documentation

◆ XCAFDoc_NotesTool()

XCAFDoc_NotesTool::XCAFDoc_NotesTool ( )

Creates an empty notes tool.

Member Function Documentation

◆ AddNote() [1/2]

Handle< XCAFDoc_AssemblyItemRef > XCAFDoc_NotesTool::AddNote	(	const TDF_Label &	theNoteLabel,
		const XCAFDoc_AssemblyItemId &	theItemId
	)

Adds the given note to the assembly item.

Parameters

[in]	theNoteLabel	- note label.
[in]	theItemId	- assembly item ID.

Returns: a handle to the assembly reference attribute.

◆ AddNote() [2/2]

Handle< XCAFDoc_AssemblyItemRef > XCAFDoc_NotesTool::AddNote	(	const TDF_Label &	theNoteLabel,
		const TDF_Label &	theItemLabel
	)

Adds the given note to the labeled item.

Parameters

[in]	theNoteLabel	- note label.
[in]	theItemLabel	- item label.

Returns: a handle to the assembly reference attribute.

◆ AddNoteToAttr() [1/2]

Handle< XCAFDoc_AssemblyItemRef > XCAFDoc_NotesTool::AddNoteToAttr	(	const TDF_Label &	theNoteLabel,
		const XCAFDoc_AssemblyItemId &	theItemId,
		const Standard_GUID &	theGUID
	)

Adds the given note to the assembly item's attribute.

Parameters

[in]	theNoteLabel	- note label.
[in]	theItemId	- assembly item ID.
[in]	theGUID	- assembly item's attribute GUID.

Returns: a handle to the assembly reference attribute.

◆ AddNoteToAttr() [2/2]

Handle< XCAFDoc_AssemblyItemRef > XCAFDoc_NotesTool::AddNoteToAttr	(	const TDF_Label &	theNoteLabel,
		const TDF_Label &	theItemLabel,
		const Standard_GUID &	theGUID
	)

Adds the given note to the labeled item's attribute.

Parameters

[in]	theNoteLabel	- note label.
[in]	theItemLabel	- item label.
[in]	theGUID	- assembly item's attribute GUID.

Returns: a handle to the assembly reference attribute.

◆ AddNoteToSubshape() [1/2]

Handle< XCAFDoc_AssemblyItemRef > XCAFDoc_NotesTool::AddNoteToSubshape	(	const TDF_Label &	theNoteLabel,
		const XCAFDoc_AssemblyItemId &	theItemId,
		Standard_Integer	theSubshapeIndex
	)

Adds the given note to the assembly item's subshape.

Parameters

[in]	theNoteLabel	- note label.
[in]	theItemId	- assembly item ID.
[in]	theSubshapeIndex	- assembly item's subshape index.

Returns: a handle to the assembly reference attribute.

◆ AddNoteToSubshape() [2/2]

Handle< XCAFDoc_AssemblyItemRef > XCAFDoc_NotesTool::AddNoteToSubshape	(	const TDF_Label &	theNoteLabel,
		const TDF_Label &	theItemLabel,
		Standard_Integer	theSubshapeIndex
	)

Adds the given note to the labeled item's subshape.

Parameters

[in]	theNoteLabel	- note label.
[in]	theItemLabel	- item label.
[in]	theSubshapeIndex	- assembly item's subshape index.

Returns: a handle to the assembly reference attribute.

◆ CreateBalloon()

Handle< XCAFDoc_Note > XCAFDoc_NotesTool::CreateBalloon	(	const TCollection_ExtendedString &	theUserName,
		const TCollection_ExtendedString &	theTimeStamp,
		const TCollection_ExtendedString &	theComment
	)

Create a new 'balloon' note. Creates a new label under the notes hive and attaches XCAFDoc_NoteBalloon attribute (derived ftom XCAFDoc_Note).

Parameters

[in]	theUserName	- the user associated with the note.
[in]	theTimeStamp	- timestamp of the note.
[in]	theComment	- textual comment.

Returns: a handle to the base note attribute.

◆ CreateBinData() [1/2]

Handle< XCAFDoc_Note > XCAFDoc_NotesTool::CreateBinData	(	const TCollection_ExtendedString &	theUserName,
		const TCollection_ExtendedString &	theTimeStamp,
		const TCollection_ExtendedString &	theTitle,
		const TCollection_AsciiString &	theMIMEtype,
		OSD_File &	theFile
	)

Create a new note with data loaded from a binary file. Creates a new label under the notes hive and attaches XCAFDoc_NoteComment attribute (derived ftom XCAFDoc_Note).

Parameters

[in]	theUserName	- the user associated with the note.
[in]	theTimeStamp	- timestamp of the note.
[in]	theTitle	- file title.
[in]	theMIMEtype	- MIME type of the file.
[in]	theFile	- input binary file.

Returns: a handle to the base note attribute.

◆ CreateBinData() [2/2]

Handle< XCAFDoc_Note > XCAFDoc_NotesTool::CreateBinData	(	const TCollection_ExtendedString &	theUserName,
		const TCollection_ExtendedString &	theTimeStamp,
		const TCollection_ExtendedString &	theTitle,
		const TCollection_AsciiString &	theMIMEtype,
		const Handle< TColStd_HArray1OfByte > &	theData
	)

Create a new note with data loaded from a byte data array. Creates a new label under the notes hive and attaches XCAFDoc_NoteComment attribute (derived ftom XCAFDoc_Note).

Parameters

[in]	theUserName	- the user associated with the note.
[in]	theTimeStamp	- timestamp of the note.
[in]	theTitle	- data title.
[in]	theMIMEtype	- MIME type of the file.
[in]	theData	- byte data array.

Returns: a handle to the base note attribute.

◆ CreateComment()

Handle< XCAFDoc_Note > XCAFDoc_NotesTool::CreateComment	(	const TCollection_ExtendedString &	theUserName,
		const TCollection_ExtendedString &	theTimeStamp,
		const TCollection_ExtendedString &	theComment
	)

Create a new comment note. Creates a new label under the notes hive and attaches XCAFDoc_NoteComment attribute (derived ftom XCAFDoc_Note).

Parameters

[in]	theUserName	- the user associated with the note.
[in]	theTimeStamp	- timestamp of the note.
[in]	theComment	- textual comment.

Returns: a handle to the base note attribute.

◆ DeleteAllNotes()

Standard_Integer XCAFDoc_NotesTool::DeleteAllNotes ( )

Deletes all notes. Clears all annotations.

Returns: number of deleted notes.

◆ DeleteNote()

Standard_Boolean XCAFDoc_NotesTool::DeleteNote ( const TDF_Label & theNoteLabel )

Deletes the given note. Removes all links with items annotated by the note.

Parameters

[in] theNoteLabel - note label.

Returns: true if the note is deleted, otherwise - false.

◆ DeleteNotes()

Standard_Integer XCAFDoc_NotesTool::DeleteNotes ( TDF_LabelSequence & theNoteLabels )

Deletes the given notes. Removes all links with items annotated by the notes.

Parameters

[in] theNoteLabels - note label sequence.

Returns: number of deleted notes.

◆ DeleteOrphanNotes()

Standard_Integer XCAFDoc_NotesTool::DeleteOrphanNotes ( )

Deletes all notes that aren't linked to annotated items.

Returns: number of deleted notes.

◆ Dump()

Standard_OStream& XCAFDoc_NotesTool::Dump ( Standard_OStream & anOS ) const

overridevirtual

Dumps the minimum information about <me> on <aStream>.

Reimplemented from TDF_Attribute.

◆ FindAnnotatedItem() [1/2]

TDF_Label XCAFDoc_NotesTool::FindAnnotatedItem ( const XCAFDoc_AssemblyItemId & theItemId ) const

Finds a label of the given assembly item ID in the annotated items hive.

Parameters

[in] theItemId - assembly item ID.

Returns: annotated item label if it is found, otherwise - null label.

◆ FindAnnotatedItem() [2/2]

TDF_Label XCAFDoc_NotesTool::FindAnnotatedItem ( const TDF_Label & theItemLabel ) const

Finds a label of the given labeled item in the annotated items hive.

Parameters

[in] theItemLabel - item label.

Returns: annotated item label if it is found, otherwise - null label.

◆ FindAnnotatedItemAttr() [1/2]

TDF_Label XCAFDoc_NotesTool::FindAnnotatedItemAttr	(	const XCAFDoc_AssemblyItemId &	theItemId,
		const Standard_GUID &	theGUID
	)		const

Finds a label of the given assembly item's attribute in the annotated items hive.

Parameters

[in]	theItemId	- assembly item ID.
[in]	theGUID	- assembly item's attribute GUID.

Returns: annotated item label if it is found, otherwise - null label.

◆ FindAnnotatedItemAttr() [2/2]

TDF_Label XCAFDoc_NotesTool::FindAnnotatedItemAttr	(	const TDF_Label &	theItemLabel,
		const Standard_GUID &	theGUID
	)		const

Finds a label of the given labeled item's attribute in the annotated items hive.

Parameters

[in]	theItemLabel	- item label.
[in]	theGUID	- item's attribute GUID.

Returns: annotated item label if it is found, otherwise - null label.

◆ FindAnnotatedItemSubshape() [1/2]

TDF_Label XCAFDoc_NotesTool::FindAnnotatedItemSubshape	(	const XCAFDoc_AssemblyItemId &	theItemId,
		Standard_Integer	theSubshapeIndex
	)		const

Finds a label of the given assembly item's subshape in the annotated items hive.

Parameters

[in]	theItemId	- assembly item ID.
[in]	theSubshapeIndex	- assembly item's subshape index.

Returns: annotated item label if it is found, otherwise - null label.

◆ FindAnnotatedItemSubshape() [2/2]

TDF_Label XCAFDoc_NotesTool::FindAnnotatedItemSubshape	(	const TDF_Label &	theItemLabel,
		Standard_Integer	theSubshapeIndex
	)		const

Finds a label of the given labeled item's subshape in the annotated items hive.

Parameters

[in]	theItemLabel	- item label.
[in]	theSubshapeIndex	- labeled item's subshape index.

Returns: annotated item label if it is found, otherwise - null label.

◆ GetAnnotatedItems()

void XCAFDoc_NotesTool::GetAnnotatedItems ( TDF_LabelSequence & theLabels ) const

Returns all labels from the annotated items hive. The label sequence isn't cleared beforehand.

Parameters

[out] theNoteLabels - sequence of labels.

◆ GetAnnotatedItemsLabel()

TDF_Label XCAFDoc_NotesTool::GetAnnotatedItemsLabel ( ) const

Returns the label of the annotated items hive.

◆ GetAttrNotes() [1/2]

Standard_Integer XCAFDoc_NotesTool::GetAttrNotes	(	const XCAFDoc_AssemblyItemId &	theItemId,
		const Standard_GUID &	theGUID,
		TDF_LabelSequence &	theNoteLabels
	)		const

Gets all note labels of the assembly item's attribute. Notes linked to the item itself or to item's subshapes aren't taken into account. The label sequence isn't cleared beforehand.

Parameters

[in]	theItemId	- assembly item ID.
[in]	theGUID	- assembly item's attribute GUID.
[out]	theNoteLabels	- sequence of labels.

Returns: number of added labels.

◆ GetAttrNotes() [2/2]

Standard_Integer XCAFDoc_NotesTool::GetAttrNotes	(	const TDF_Label &	theItemLabel,
		const Standard_GUID &	theGUID,
		TDF_LabelSequence &	theNoteLabels
	)		const

Gets all note labels of the labeled item's attribute. Notes linked to the item itself or to item's subshapes aren't taken into account. The label sequence isn't cleared beforehand.

Parameters

[in]	theItemLabel	- item label.
[in]	theGUID	- item's attribute GUID.
[out]	theNoteLabels	- sequence of labels.

Returns: number of added labels.

◆ GetID()

static const Standard_GUID& XCAFDoc_NotesTool::GetID ( )

static

Returns default attribute GUID.

◆ GetNotes() [1/3]

void XCAFDoc_NotesTool::GetNotes ( TDF_LabelSequence & theNoteLabels ) const

Returns all labels from the notes hive. The label sequence isn't cleared beforehand.

Parameters

[out] theNoteLabels - sequence of labels.

◆ GetNotes() [2/3]

Standard_Integer XCAFDoc_NotesTool::GetNotes	(	const XCAFDoc_AssemblyItemId &	theItemId,
		TDF_LabelSequence &	theNoteLabels
	)		const

Gets all note labels of the assembly item. Notes linked to item's subshapes or attributes aren't taken into account. The label sequence isn't cleared beforehand.

Parameters

[in]	theItemId	- assembly item ID.
[out]	theNoteLabels	- sequence of labels.

Returns: number of added labels.

◆ GetNotes() [3/3]

Standard_Integer XCAFDoc_NotesTool::GetNotes	(	const TDF_Label &	theItemLabel,
		TDF_LabelSequence &	theNoteLabels
	)		const

Gets all note labels of the labeled item. Notes linked to item's attributes aren't taken into account. The label sequence isn't cleared beforehand.

Parameters

[in]	theItemLabel	- item label.
[out]	theNoteLabels	- sequence of labels.

Returns: number of added labels.

◆ GetNotesLabel()

TDF_Label XCAFDoc_NotesTool::GetNotesLabel ( ) const

Returns the label of the notes hive.

◆ GetOrphanNotes()

void XCAFDoc_NotesTool::GetOrphanNotes ( TDF_LabelSequence & theNoteLabels ) const

Returns note labels that aren't linked to annotated items. The label sequence isn't cleared beforehand.

Parameters

[out] theNoteLabels - sequence of labels.

◆ GetSubshapeNotes()

Standard_Integer XCAFDoc_NotesTool::GetSubshapeNotes	(	const XCAFDoc_AssemblyItemId &	theItemId,
		Standard_Integer	theSubshapeIndex,
		TDF_LabelSequence &	theNoteLabels
	)		const

Gets all note labels of the annotated item. Notes linked to the item itself or to item's attributes taken into account. The label sequence isn't cleared beforehand.

Parameters

[in]	theItemId	- assembly item ID.
[in]	theSubshapeIndex	- assembly item's subshape index.
[out]	theNoteLabels	- sequence of labels.

Returns: number of added labels.

◆ ID()

const Standard_GUID& XCAFDoc_NotesTool::ID ( ) const

overridevirtual

Returns the ID of the attribute.

Implements TDF_Attribute.

◆ IsAnnotatedItem() [1/2]

Standard_Boolean XCAFDoc_NotesTool::IsAnnotatedItem ( const XCAFDoc_AssemblyItemId & theItemId ) const

Checks if the given assembly item is annotated.

Parameters

[in] theItemId - assembly item ID.

Returns: true if the item is annotated, otherwise - false.

◆ IsAnnotatedItem() [2/2]

Standard_Boolean XCAFDoc_NotesTool::IsAnnotatedItem ( const TDF_Label & theItemLabel ) const

Checks if the given labeled item is annotated.

Parameters

[in] theItemLabel - item label.

Returns: true if the item is annotated, otherwise - false.

◆ NbAnnotatedItems()

Standard_Integer XCAFDoc_NotesTool::NbAnnotatedItems ( ) const

Returns the number of labels in the annotated items hive.

◆ NbNotes()

Standard_Integer XCAFDoc_NotesTool::NbNotes ( ) const

Returns the number of labels in the notes hive.

◆ NbOrphanNotes()

Standard_Integer XCAFDoc_NotesTool::NbOrphanNotes ( ) const

Returns number of notes that aren't linked to annotated items.

◆ RemoveAllAttrNotes() [1/2]

Standard_Boolean XCAFDoc_NotesTool::RemoveAllAttrNotes	(	const XCAFDoc_AssemblyItemId &	theItemId,
		const Standard_GUID &	theGUID,
		Standard_Boolean	theDelIfOrphan = `Standard_False`
	)

Removes all notes from the assembly item's attribute.

Parameters

[in]	theItemId	- assembly item ID.
[in]	theGUID	- assembly item's attribute GUID.
[in]	theDelIfOrphan	- deletes removed notes from the notes hive if there are no more annotated items linked with the notes.

Returns: true if the notes are removed, otherwise - false.

◆ RemoveAllAttrNotes() [2/2]

Standard_Boolean XCAFDoc_NotesTool::RemoveAllAttrNotes	(	const TDF_Label &	theItemLabel,
		const Standard_GUID &	theGUID,
		Standard_Boolean	theDelIfOrphan = `Standard_False`
	)

Removes all notes from the labeled item's attribute.

Parameters

[in]	theItemLabel	- item label.
[in]	theGUID	- labeled item's attribute GUID.
[in]	theDelIfOrphan	- deletes removed notes from the notes hive if there are no more annotated items linked with the notes.

Returns: true if the notes are removed, otherwise - false.

◆ RemoveAllNotes() [1/2]

Standard_Boolean XCAFDoc_NotesTool::RemoveAllNotes	(	const XCAFDoc_AssemblyItemId &	theItemId,
		Standard_Boolean	theDelIfOrphan = `Standard_False`
	)

Removes all notes from the assembly item.

Parameters

[in]	theItemId	- assembly item ID.
[in]	theDelIfOrphan	- deletes removed notes from the notes hive if there are no more annotated items linked with the notes.

Returns: true if the notes are removed, otherwise - false.

◆ RemoveAllNotes() [2/2]

Standard_Boolean XCAFDoc_NotesTool::RemoveAllNotes	(	const TDF_Label &	theItemLabel,
		Standard_Boolean	theDelIfOrphan = `Standard_False`
	)

Removes all notes from the labeled item.

Parameters

[in]	theItemLabel	- item label.
[in]	theDelIfOrphan	- deletes removed notes from the notes hive if there are no more annotated items linked with the notes.

Returns: true if the notes are removed, otherwise - false.

◆ RemoveAllSubshapeNotes()

Standard_Boolean XCAFDoc_NotesTool::RemoveAllSubshapeNotes	(	const XCAFDoc_AssemblyItemId &	theItemId,
		Standard_Integer	theSubshapeIndex,
		Standard_Boolean	theDelIfOrphan = `Standard_False`
	)

Removes all notes from the assembly item's subshape.

Parameters

[in]	theItemId	- assembly item ID.
[in]	theSubshapeIndex	- assembly item's subshape index.
[in]	theDelIfOrphan	- deletes removed notes from the notes hive if there are no more annotated items linked with the notes.

Returns: true if the notes are removed, otherwise - false.

◆ RemoveAttrNote() [1/2]

Standard_Boolean XCAFDoc_NotesTool::RemoveAttrNote	(	const TDF_Label &	theNoteLabel,
		const XCAFDoc_AssemblyItemId &	theItemId,
		const Standard_GUID &	theGUID,
		Standard_Boolean	theDelIfOrphan = `Standard_False`
	)

Removes a note from the assembly item's attribute.

Parameters

[in]	theNoteLabel	- note label.
[in]	theItemId	- assembly item ID.
[in]	theGUID	- assembly item's attribute GUID.
[in]	theDelIfOrphan	- deletes the note from the notes hive if there are no more assembly item's attribute linked with the note.

Returns: true if the note is removed, otherwise - false.

◆ RemoveAttrNote() [2/2]

Standard_Boolean XCAFDoc_NotesTool::RemoveAttrNote	(	const TDF_Label &	theNoteLabel,
		const TDF_Label &	theItemLabel,
		const Standard_GUID &	theGUID,
		Standard_Boolean	theDelIfOrphan = `Standard_False`
	)

Removes a note from the labeled item's attribute.

Parameters

[in]	theNoteLabel	- note label.
[in]	theItemLabel	- item label.
[in]	theGUID	- labeled item's attribute GUID.
[in]	theDelIfOrphan	- deletes the note from the notes hive if there are no more assembly item's attribute linked with the note.

Returns: true if the note is removed, otherwise - false.

◆ RemoveNote() [1/2]

Standard_Boolean XCAFDoc_NotesTool::RemoveNote	(	const TDF_Label &	theNoteLabel,
		const XCAFDoc_AssemblyItemId &	theItemId,
		Standard_Boolean	theDelIfOrphan = `Standard_False`
	)

Removes the given note from the assembly item.

Parameters

[in]	theNoteLabel	- note label.
[in]	theItemId	- assembly item ID.
[in]	theDelIfOrphan	- deletes the note from the notes hive if there are no more assembly items linked with the note.

Returns: true if the note is removed, otherwise - false.

◆ RemoveNote() [2/2]

Standard_Boolean XCAFDoc_NotesTool::RemoveNote	(	const TDF_Label &	theNoteLabel,
		const TDF_Label &	theItemLabel,
		Standard_Boolean	theDelIfOrphan = `Standard_False`
	)

Removes the given note from the labeled item.

Parameters

[in]	theNoteLabel	- note label.
[in]	theItemLabel	- item label.
[in]	theDelIfOrphan	- deletes the note from the notes hive if there are no more labeled items linked with the note.

Returns: true if the note is removed, otherwise - false.

◆ RemoveSubshapeNote() [1/2]

Standard_Boolean XCAFDoc_NotesTool::RemoveSubshapeNote	(	const TDF_Label &	theNoteLabel,
		const XCAFDoc_AssemblyItemId &	theItemId,
		Standard_Integer	theSubshapeIndex,
		Standard_Boolean	theDelIfOrphan = `Standard_False`
	)

Removes the given note from the assembly item's subshape.

Parameters

[in]	theNoteLabel	- note label.
[in]	theItemId	- assembly item ID.
[in]	theSubshapeIndex	- assembly item's subshape index.
[in]	theDelIfOrphan	- deletes the note from the notes hive if there are no more assembly item's subshape linked with the note.

Returns: true if the note is removed, otherwise - false.

◆ RemoveSubshapeNote() [2/2]

Standard_Boolean XCAFDoc_NotesTool::RemoveSubshapeNote	(	const TDF_Label &	theNoteLabel,
		const TDF_Label &	theItemLabel,
		Standard_Integer	theSubshapeIndex,
		Standard_Boolean	theDelIfOrphan = `Standard_False`
	)

Removes the given note from the labeled item's subshape.

Parameters

[in]	theNoteLabel	- note label.
[in]	theItemLabel	- item label.
[in]	theSubshapeIndex	- labeled item's subshape index.
[in]	theDelIfOrphan	- deletes the note from the notes hive if there are no more assembly item's subshape linked with the note.

Returns: true if the note is removed, otherwise - false.

◆ Set()

static Handle< XCAFDoc_NotesTool > XCAFDoc_NotesTool::Set ( const TDF_Label & theLabel )

static

Create (if not exist) a notes tool from XCAFDoc on theLabel.

The documentation for this class was generated from the following file:

XCAFDoc_NotesTool.hxx

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

| 0:1 |

|1

| 0:1:9 |

Constructor & Destructor Documentation

◆ XCAFDoc_NotesTool()

Member Function Documentation

◆ AddNote() [1/2]

◆ AddNote() [2/2]

◆ AddNoteToAttr() [1/2]

◆ AddNoteToAttr() [2/2]

◆ AddNoteToSubshape() [1/2]

◆ AddNoteToSubshape() [2/2]

◆ CreateBalloon()

◆ CreateBinData() [1/2]

◆ CreateBinData() [2/2]

◆ CreateComment()

◆ DeleteAllNotes()

◆ DeleteNote()

◆ DeleteNotes()

◆ DeleteOrphanNotes()

◆ Dump()

◆ FindAnnotatedItem() [1/2]

◆ FindAnnotatedItem() [2/2]

◆ FindAnnotatedItemAttr() [1/2]

◆ FindAnnotatedItemAttr() [2/2]

◆ FindAnnotatedItemSubshape() [1/2]

◆ FindAnnotatedItemSubshape() [2/2]

◆ GetAnnotatedItems()

◆ GetAnnotatedItemsLabel()

◆ GetAttrNotes() [1/2]

◆ GetAttrNotes() [2/2]

◆ GetID()

◆ GetNotes() [1/3]

◆ GetNotes() [2/3]

◆ GetNotes() [3/3]

◆ GetNotesLabel()

◆ GetOrphanNotes()

◆ GetSubshapeNotes()

◆ ID()

◆ IsAnnotatedItem() [1/2]

◆ IsAnnotatedItem() [2/2]

◆ NbAnnotatedItems()

◆ NbNotes()

◆ NbOrphanNotes()

◆ RemoveAllAttrNotes() [1/2]

◆ RemoveAllAttrNotes() [2/2]

◆ RemoveAllNotes() [1/2]

◆ RemoveAllNotes() [2/2]

◆ RemoveAllSubshapeNotes()

◆ RemoveAttrNote() [1/2]

◆ RemoveAttrNote() [2/2]

◆ RemoveNote() [1/2]

◆ RemoveNote() [2/2]

◆ RemoveSubshapeNote() [1/2]

◆ RemoveSubshapeNote() [2/2]

◆ Set()