This attribute store the topological naming of any selected shape, when this shape is not already attached to a specific label. This class is also used to solve it when the argumentsof the toipological naming are modified. More...

#include <TNaming_Naming.hxx>

Inheritance diagram for TNaming_Naming:

[legend]

Public Member Functions
	TNaming_Naming ()

Standard_Boolean	IsDefined () const

const TNaming_Name &	GetName () const

TNaming_Name &	ChangeName ()

Standard_Boolean	Regenerate (TDF_LabelMap &scope)
	regenerate only the Name associated to me

Standard_Boolean	Solve (TDF_LabelMap &scope)
	Regenerate recursively the whole name with scope. If scope is empty it means that all the labels of the framework are valid.

virtual const Standard_GUID &	ID () const override

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

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

void	Paste (const Handle< TDF_Attribute > &Into, const 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>.

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

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

virtual void	ExtendedDump (Standard_OStream &anOS, const TDF_IDFilter &aFilter, TDF_AttributeIndexedMap &aMap) const override
	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	DumpJson (Standard_OStream &theOStream, Standard_Integer 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.

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

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.

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

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

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

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

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.

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

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

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.

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.

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	BeforeForget ()
	Something to do before forgetting an Attribute to a label.

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

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.

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.

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.

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

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

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

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

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

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

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

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

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

Standard_OStream &	operator<< (Standard_OStream &anOS) const

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

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 ()
	Destructor must be virtual.

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

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

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

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.

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.

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.

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

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

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

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

Static Public Member Functions
static const Standard_GUID &	GetID ()

static Handle< TNaming_Naming >	Insert (const TDF_Label &under)

static Handle< TNaming_NamedShape >	Name (const TDF_Label &where, const TopoDS_Shape &Selection, const TopoDS_Shape &Context, const Standard_Boolean Geometry=Standard_False, const Standard_Boolean KeepOrientation=Standard_False, const Standard_Boolean BNproblem=Standard_False)
	Creates a Namimg attribute at label <where> to identify the shape <Selection>. Geometry is Standard_True if we are only interested by the underlying geometry (e.g. setting a constraint). <Context> is used to find neighbours of when required by the naming. If KeepOrientation is True the Selection orientation is taken into account. BNproblem == True points out that Context sub-shapes in DF have orientation differences with Context shape itself.

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 store the topological naming of any selected shape, when this shape is not already attached to a specific label. This class is also used to solve it when the argumentsof the toipological naming are modified.

Constructor & Destructor Documentation

◆ TNaming_Naming()

TNaming_Naming::TNaming_Naming ( )

Member Function Documentation

◆ ChangeName()

TNaming_Name & TNaming_Naming::ChangeName ( )

◆ Dump()

virtual Standard_OStream & TNaming_Naming::Dump ( Standard_OStream & anOS ) const

overridevirtual

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

Reimplemented from TDF_Attribute.

◆ DumpJson()

void TNaming_Naming::DumpJson	(	Standard_OStream &	theOStream,
		Standard_Integer	theDepth = -1 ) const

overridevirtual

Dumps the content of me into the stream.

Reimplemented from TDF_Attribute.

◆ ExtendedDump()

virtual void TNaming_Naming::ExtendedDump	(	Standard_OStream &	anOS,
		const TDF_IDFilter &	aFilter,
		TDF_AttributeIndexedMap &	aMap ) const

overridevirtual

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.

Reimplemented from TDF_Attribute.

◆ GetID()

static const Standard_GUID & TNaming_Naming::GetID ( )

static

following code from TDesignStd

◆ GetName()

const TNaming_Name & TNaming_Naming::GetName ( ) const

◆ ID()

virtual const Standard_GUID & TNaming_Naming::ID ( ) const

overridevirtual

Deferred methods from TDF_Attribute

Implements TDF_Attribute.

◆ Insert()

static Handle< TNaming_Naming > TNaming_Naming::Insert ( const TDF_Label & under )

static

◆ IsDefined()

Standard_Boolean TNaming_Naming::IsDefined ( ) const

◆ Name()

static Handle< TNaming_NamedShape > TNaming_Naming::Name	(	const TDF_Label &	where,
		const TopoDS_Shape &	Selection,
		const TopoDS_Shape &	Context,
		const Standard_Boolean	Geometry = Standard_False,
		const Standard_Boolean	KeepOrientation = Standard_False,
		const Standard_Boolean	BNproblem = Standard_False )

static

Creates a Namimg attribute at label <where> to identify the shape <Selection>. Geometry is Standard_True if we are only interested by the underlying geometry (e.g. setting a constraint). <Context> is used to find neighbours of when required by the naming. If KeepOrientation is True the Selection orientation is taken into account. BNproblem == True points out that Context sub-shapes in DF have orientation differences with Context shape itself.

instance method

◆ NewEmpty()

Handle< TDF_Attribute > TNaming_Naming::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 TNaming_Naming::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.

◆ References()

virtual void TNaming_Naming::References ( const 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.

◆ Regenerate()

Standard_Boolean TNaming_Naming::Regenerate ( TDF_LabelMap & scope )

regenerate only the Name associated to me

◆ Restore()

void TNaming_Naming::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.

◆ Solve()

Standard_Boolean TNaming_Naming::Solve ( TDF_LabelMap & scope )

Regenerate recursively the whole name with scope. If scope is empty it means that all the labels of the framework are valid.

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

TNaming_Naming.hxx

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ TNaming_Naming()

Member Function Documentation

◆ ChangeName()

◆ Dump()

◆ DumpJson()

◆ ExtendedDump()

◆ GetID()

following code from TDesignStd

◆ GetName()

◆ ID()

Deferred methods from TDF_Attribute

◆ Insert()

◆ IsDefined()

◆ Name()

instance method

◆ NewEmpty()

◆ Paste()

◆ References()

◆ Regenerate()

◆ Restore()

◆ Solve()