A base note attribute. Any note contains the name of the user created the note and the creation timestamp. More...

#include <XCAFDoc_Note.hxx>

Inheritance diagram for XCAFDoc_Note:

[legend]

Public Member Functions
void	Set (const TCollection_ExtendedString &theUserName, const TCollection_ExtendedString &theTimeStamp)
	Sets the user name and the timestamp of the note. More...

const TCollection_ExtendedString &	UserName () const
	Returns the user name, who created the note. More...

const TCollection_ExtendedString &	TimeStamp () const
	Returns the timestamp of the note. More...

Standard_Boolean	IsOrphan () const
	Checks if the note isn't linked to annotated items. More...

Handle< XCAFNoteObjects_NoteObject >	GetObject () const
	Returns auxiliary data object. More...

void	SetObject (const Handle< XCAFNoteObjects_NoteObject > &theObject)
	Updates auxiliary data. More...

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

void	Paste (const Handle< TDF_Attribute > &theAttrInto, const Handle< TDF_RelocationTable > &theRT) 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...

Standard_OStream &	Dump (Standard_OStream &theOS) const override
	Dumps the minimum information about <me> on <aStream>. 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 const Standard_GUID &	ID () const =0
	Returns the ID of the attribute. More...

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 Standard_Boolean	IsMine (const TDF_Label &theLabel)
	Checks if the given label represents a note. More...

static Handle< XCAFDoc_Note >	Get (const TDF_Label &theLabel)
	Finds a reference attribute on the given label and returns it, if it is found. 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...

Protected Member Functions
	XCAFDoc_Note ()
	Creates an empty note. More...

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

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

Detailed Description

A base note attribute. Any note contains the name of the user created the note and the creation timestamp.

Constructor & Destructor Documentation

◆ XCAFDoc_Note()

XCAFDoc_Note::XCAFDoc_Note ( )

protected

Creates an empty note.

Member Function Documentation

◆ Dump()

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

overridevirtual

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

Reimplemented from TDF_Attribute.

Reimplemented in XCAFDoc_NoteBinData, and XCAFDoc_NoteComment.

◆ DumpJson()

virtual void XCAFDoc_Note::DumpJson	(	Standard_OStream &	theOStream,
		Standard_Integer	theDepth = `-1`
	)		const

overridevirtual

Dumps the content of me into the stream.

Reimplemented from TDF_Attribute.

◆ Get()

static Handle< XCAFDoc_Note > XCAFDoc_Note::Get ( const TDF_Label & theLabel )

static

Finds a reference attribute on the given label and returns it, if it is found.

◆ GetObject()

Handle< XCAFNoteObjects_NoteObject > XCAFDoc_Note::GetObject ( ) const

Returns auxiliary data object.

◆ IsMine()

static Standard_Boolean XCAFDoc_Note::IsMine ( const TDF_Label & theLabel )

static

Checks if the given label represents a note.

◆ IsOrphan()

Standard_Boolean XCAFDoc_Note::IsOrphan ( ) const

Checks if the note isn't linked to annotated items.

◆ Paste()

void XCAFDoc_Note::Paste	(	const Handle< TDF_Attribute > &	intoAttribute,
		const Handle< TDF_RelocationTable > &	aRelocationTable
	)		const

overridevirtual

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>.

The given pasted attribute can be full or empty of its contents. But don't make a NEW! Just set the contents!

It is possible to use <aRelocationTable> to get/set the relocation value of a source attribute.

Implements TDF_Attribute.

Reimplemented in XCAFDoc_NoteBinData, and XCAFDoc_NoteComment.

◆ Restore()

void XCAFDoc_Note::Restore ( const Handle< TDF_Attribute > & anAttribute )

overridevirtual

Restores the backuped contents from <anAttribute> into this one. It is used when aborting a transaction.

Implements TDF_Attribute.

Reimplemented in XCAFDoc_NoteBinData, and XCAFDoc_NoteComment.

◆ Set()

void XCAFDoc_Note::Set	(	const TCollection_ExtendedString &	theUserName,
		const TCollection_ExtendedString &	theTimeStamp
	)

Sets the user name and the timestamp of the note.

Parameters

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

Returns: A handle to the attribute instance.

◆ SetObject()

void XCAFDoc_Note::SetObject ( const Handle< XCAFNoteObjects_NoteObject > & theObject )

Updates auxiliary data.

◆ TimeStamp()

const TCollection_ExtendedString& XCAFDoc_Note::TimeStamp ( ) const

inline

Returns the timestamp of the note.

◆ UserName()

const TCollection_ExtendedString& XCAFDoc_Note::UserName ( ) const

inline

Returns the user name, who created the note.

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

XCAFDoc_Note.hxx

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ XCAFDoc_Note()

Member Function Documentation

◆ Dump()

◆ DumpJson()

◆ Get()

◆ GetObject()

◆ IsMine()

◆ IsOrphan()

◆ Paste()

◆ Restore()

◆ Set()

◆ SetObject()

◆ TimeStamp()

◆ UserName()