This attribute allow user multirelation tree of labels. This GraphNode is experimental Graph that not control looping and redundance. Attribute containing sequence of father's and child's labels. Provide create and work with Graph in XCAFDocument. More...

#include <XCAFDoc_GraphNode.hxx>

Inheritance diagram for XCAFDoc_GraphNode:

[legend]

Public Member Functions
	XCAFDoc_GraphNode ()

void	SetGraphID (const Standard_GUID &explicitID)

int	SetFather (const occ::handle< XCAFDoc_GraphNode > &F)
	Set GraphNode <F> as father of me and returns index of <F> in Sequence that containing Fathers GraphNodes. return index of <F> from GraphNodeSequnece.

int	SetChild (const occ::handle< XCAFDoc_GraphNode > &Ch)
	Set GraphNode <Ch> as child of me and returns index of <Ch> in Sequence that containing Children GraphNodes. return index of <Ch> from GraphNodeSequnece.

void	UnSetFather (const occ::handle< XCAFDoc_GraphNode > &F)
	Remove <F> from Fathers GraphNodeSequence. and remove link between father and child.

void	UnSetFather (const int Findex)
	Remove Father GraphNode by index from Fathers GraphNodeSequence. and remove link between father and child.

void	UnSetChild (const occ::handle< XCAFDoc_GraphNode > &Ch)
	Remove <Ch> from GraphNodeSequence. and remove link between father and child.

void	UnSetChild (const int Chindex)
	Remove Child GraphNode by index from Children GraphNodeSequence. and remove link between father and child.

occ::handle< XCAFDoc_GraphNode >	GetFather (const int Findex) const
	Return GraphNode by index from GraphNodeSequence.

occ::handle< XCAFDoc_GraphNode >	GetChild (const int Chindex) const
	Return GraphNode by index from GraphNodeSequence.

int	FatherIndex (const occ::handle< XCAFDoc_GraphNode > &F) const
	Return index of <F>, or zero if there is no such Graphnode.

int	ChildIndex (const occ::handle< XCAFDoc_GraphNode > &Ch) const
	Return index of <Ch>, or zero if there is no such Graphnode.

bool	IsFather (const occ::handle< XCAFDoc_GraphNode > &Ch) const
	returns TRUE if <me> is father of <Ch>.

bool	IsChild (const occ::handle< XCAFDoc_GraphNode > &F) const
	returns TRUE if <me> is child of <F>.

int	NbFathers () const
	return Number of Fathers GraphNodes.

int	NbChildren () const
	return Number of Childrens GraphNodes.

const Standard_GUID &	ID () const override
	Returns the Graph ID (default or explicit one depending on the Set method used).

void	Restore (const occ::handle< TDF_Attribute > &with) override
	Restores the backuped contents from <anAttribute> into this one. It is used when aborting a transaction.

void	Paste (const occ::handle< TDF_Attribute > &into, const occ::handle< TDF_RelocationTable > &RT) 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>.

occ::handle< TDF_Attribute >	NewEmpty () const override
	Returns an new empty attribute from the good end type. It is used by the copy algorithm.

void	References (const occ::handle< TDF_DataSet > &aDataSet) const override
	Adds the first level referenced attributes and labels to <aDataSet>.

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

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

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

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

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

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.

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

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

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

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

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

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

bool	FindAttribute (const Standard_GUID &anID, occ::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.

template<class T >
bool	FindAttribute (const Standard_GUID &theID, occ::handle< T > &theAttr) const
	Safe variant for arbitrary type of argument.

void	AddAttribute (const occ::handle< TDF_Attribute > &other) const
	Adds an Attribute <other> to the label of <me>. Raises if there is already one of the same GUID than <other>.

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

void	ForgetAllAttributes (const bool clearChildren=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.

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

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

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

virtual bool	AfterRetrieval (const bool forceIt=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.

virtual bool	BeforeUndo (const occ::handle< TDF_AttributeDelta > &anAttDelta, const bool forceIt=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.

virtual bool	AfterUndo (const occ::handle< TDF_AttributeDelta > &anAttDelta, const bool forceIt=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.

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

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

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

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

virtual occ::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).

virtual occ::handle< TDF_DeltaOnForget >	DeltaOnForget () const
	Makes an AttributeDelta because <me> has been forgotten.

virtual occ::handle< TDF_DeltaOnResume >	DeltaOnResume () const
	Makes an AttributeDelta because <me> has been resumed.

virtual occ::handle< TDF_DeltaOnModification >	DeltaOnModification (const occ::handle< TDF_Attribute > &anOldAttribute) const
	Makes a DeltaOnModification between <me> and.

virtual void	DeltaOnModification (const occ::handle< TDF_DeltaOnModification > &aDelta)
	Applies a DeltaOnModification to <me>.

virtual occ::handle< TDF_DeltaOnRemoval >	DeltaOnRemoval () const
	Makes a DeltaOnRemoval on <me> because <me> has disappeared from the DS.

Standard_OStream &	operator<< (Standard_OStream &anOS) const

virtual void	ExtendedDump (Standard_OStream &anOS, const TDF_IDFilter &aFilter, NCollection_IndexedMap< occ::handle< TDF_Attribute > > &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.

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

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

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

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

virtual	~Standard_Transient ()=default
	Destructor must be virtual.

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

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

bool	IsInstance (const char *const theTypeName) const
	Returns a true value if this is an instance of TypeName.

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

bool	IsKind (const char *const 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.

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.

int	GetRefCount () const noexcept
	Get the reference counter of this object.

void	IncrementRefCounter () noexcept
	Increments the reference counter of this object. Uses relaxed memory ordering since incrementing only requires atomicity, not synchronization with other memory operations.

int	DecrementRefCounter () noexcept
	Decrements the reference counter of this object; returns the decremented value. Uses release ordering for the decrement to ensure all writes to the object are visible before the count reaches zero. An acquire fence is added only when the count reaches zero, ensuring proper synchronization before deletion. This is more efficient than using acq_rel for every decrement.

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

Static Public Member Functions
static bool	Find (const TDF_Label &L, occ::handle< XCAFDoc_GraphNode > &G)

static occ::handle< XCAFDoc_GraphNode >	Set (const TDF_Label &L)
	Finds or Creates a GraphNode attribute on the label <L> with the default Graph ID, returned by the method <GetDefaultGraphID>. Returns the created/found GraphNode attribute.

static occ::handle< XCAFDoc_GraphNode >	Set (const TDF_Label &L, const Standard_GUID &ExplicitGraphID)
	Finds or Creates a GraphNode attribute on the label <L>, with an explicit tree ID. <ExplicitGraphID> is the ID returned by <TDF_Attribute::ID> method. Returns the found/created GraphNode attribute.

static const Standard_GUID &	GetDefaultGraphID ()
	returns a default Graph ID. this ID is used by the <Set> method without explicit tree ID.

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

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

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

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

Detailed Description

This attribute allow user multirelation tree of labels. This GraphNode is experimental Graph that not control looping and redundance. Attribute containing sequence of father's and child's labels. Provide create and work with Graph in XCAFDocument.

Constructor & Destructor Documentation

◆ XCAFDoc_GraphNode()

XCAFDoc_GraphNode::XCAFDoc_GraphNode ( )

Member Function Documentation

◆ BeforeForget()

void XCAFDoc_GraphNode::BeforeForget ( )

overridevirtual

Something to do before forgetting an Attribute to a label.

Reimplemented from TDF_Attribute.

◆ ChildIndex()

int XCAFDoc_GraphNode::ChildIndex ( const occ::handle< XCAFDoc_GraphNode > & Ch ) const

Return index of <Ch>, or zero if there is no such Graphnode.

◆ Dump()

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

overridevirtual

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

Reimplemented from TDF_Attribute.

◆ DumpJson()

void XCAFDoc_GraphNode::DumpJson	(	Standard_OStream &	theOStream,
		int	theDepth = -1 ) const

overridevirtual

Dumps the content of me into the stream.

Reimplemented from TDF_Attribute.

◆ FatherIndex()

int XCAFDoc_GraphNode::FatherIndex ( const occ::handle< XCAFDoc_GraphNode > & F ) const

Return index of <F>, or zero if there is no such Graphnode.

◆ Find()

static bool XCAFDoc_GraphNode::Find	(	const TDF_Label &	L,
		occ::handle< XCAFDoc_GraphNode > &	G )

static

class methods working on the node

Shortcut to search a Graph node attribute with default GraphID. Returns true if found.

◆ GetChild()

occ::handle< XCAFDoc_GraphNode > XCAFDoc_GraphNode::GetChild ( const int Chindex ) const

Return GraphNode by index from GraphNodeSequence.

◆ GetDefaultGraphID()

static const Standard_GUID & XCAFDoc_GraphNode::GetDefaultGraphID ( )

static

returns a default Graph ID. this ID is used by the <Set> method without explicit tree ID.

Instance methods:

◆ GetFather()

occ::handle< XCAFDoc_GraphNode > XCAFDoc_GraphNode::GetFather ( const int Findex ) const

Return GraphNode by index from GraphNodeSequence.

◆ ID()

const Standard_GUID & XCAFDoc_GraphNode::ID ( ) const

overridevirtual

Returns the Graph ID (default or explicit one depending on the Set method used).

Implements TDF_Attribute.

◆ IsChild()

bool XCAFDoc_GraphNode::IsChild ( const occ::handle< XCAFDoc_GraphNode > & F ) const

returns TRUE if <me> is child of <F>.

◆ IsFather()

bool XCAFDoc_GraphNode::IsFather ( const occ::handle< XCAFDoc_GraphNode > & Ch ) const

returns TRUE if <me> is father of <Ch>.

◆ NbChildren()

int XCAFDoc_GraphNode::NbChildren ( ) const

return Number of Childrens GraphNodes.

Implementation of Attribute methods:

◆ NbFathers()

int XCAFDoc_GraphNode::NbFathers ( ) const

return Number of Fathers GraphNodes.

◆ NewEmpty()

occ::handle< TDF_Attribute > XCAFDoc_GraphNode::NewEmpty ( ) const

overridevirtual

Returns an new empty attribute from the good end type. It is used by the copy algorithm.

Implements TDF_Attribute.

◆ Paste()

void XCAFDoc_GraphNode::Paste	(	const occ::handle< TDF_Attribute > &	intoAttribute,
		const occ::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.

◆ References()

void XCAFDoc_GraphNode::References ( const occ::handle< TDF_DataSet > & aDataSet ) const

overridevirtual

Adds the first level referenced attributes and labels to <aDataSet>.

For this, use the AddLabel or AddAttribute of DataSet.

If there is none, do not implement the method.

Reimplemented from TDF_Attribute.

◆ Restore()

void XCAFDoc_GraphNode::Restore ( const occ::handle< TDF_Attribute > & anAttribute )

overridevirtual

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

Implements TDF_Attribute.

◆ Set() [1/2]

static occ::handle< XCAFDoc_GraphNode > XCAFDoc_GraphNode::Set ( const TDF_Label & L )

static

Finds or Creates a GraphNode attribute on the label <L> with the default Graph ID, returned by the method <GetDefaultGraphID>. Returns the created/found GraphNode attribute.

◆ Set() [2/2]

static occ::handle< XCAFDoc_GraphNode > XCAFDoc_GraphNode::Set	(	const TDF_Label &	L,
		const Standard_GUID &	ExplicitGraphID )

static

Finds or Creates a GraphNode attribute on the label <L>, with an explicit tree ID. <ExplicitGraphID> is the ID returned by <TDF_Attribute::ID> method. Returns the found/created GraphNode attribute.

◆ SetChild()

int XCAFDoc_GraphNode::SetChild ( const occ::handle< XCAFDoc_GraphNode > & Ch )

Set GraphNode <Ch> as child of me and returns index of <Ch> in Sequence that containing Children GraphNodes. return index of <Ch> from GraphNodeSequnece.

◆ SetFather()

int XCAFDoc_GraphNode::SetFather ( const occ::handle< XCAFDoc_GraphNode > & F )

Set GraphNode <F> as father of me and returns index of <F> in Sequence that containing Fathers GraphNodes. return index of <F> from GraphNodeSequnece.

◆ SetGraphID()

void XCAFDoc_GraphNode::SetGraphID ( const Standard_GUID & explicitID )

◆ UnSetChild() [1/2]

void XCAFDoc_GraphNode::UnSetChild ( const int Chindex )

Remove Child GraphNode by index from Children GraphNodeSequence. and remove link between father and child.

◆ UnSetChild() [2/2]

void XCAFDoc_GraphNode::UnSetChild ( const occ::handle< XCAFDoc_GraphNode > & Ch )

Remove <Ch> from GraphNodeSequence. and remove link between father and child.

◆ UnSetFather() [1/2]

void XCAFDoc_GraphNode::UnSetFather ( const int Findex )

Remove Father GraphNode by index from Fathers GraphNodeSequence. and remove link between father and child.

◆ UnSetFather() [2/2]

void XCAFDoc_GraphNode::UnSetFather ( const occ::handle< XCAFDoc_GraphNode > & F )

Remove <F> from Fathers GraphNodeSequence. and remove link between father and child.

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

XCAFDoc_GraphNode.hxx

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ XCAFDoc_GraphNode()

Member Function Documentation

◆ BeforeForget()

◆ ChildIndex()

◆ Dump()

◆ DumpJson()

◆ FatherIndex()

◆ Find()

class methods working on the node

◆ GetChild()

◆ GetDefaultGraphID()

Instance methods:

◆ GetFather()

◆ ID()

◆ IsChild()

◆ IsFather()

◆ NbChildren()

Implementation of Attribute methods:

◆ NbFathers()

◆ NewEmpty()

◆ Paste()

◆ References()

◆ Restore()

◆ Set() [1/2]

◆ Set() [2/2]

◆ SetChild()

◆ SetFather()

◆ SetGraphID()

◆ UnSetChild() [1/2]

◆ UnSetChild() [2/2]

◆ UnSetFather() [1/2]

◆ UnSetFather() [2/2]