The basis to define an attribute for the storage of
topology and naming data.
This attribute contains two parts:
More...

#include <TNaming_NamedShape.hxx>

Inheritance diagram for TNaming_NamedShape:

[legend]

Public Member Functions
	TNaming_NamedShape ()

Standard_Boolean	IsEmpty () const

TopoDS_Shape	Get () const
	Returns the shapes contained in <NS>. Returns a null shape if IsEmpty. More...

TNaming_Evolution	Evolution () const
	Returns the Evolution of the attribute. More...

Standard_Integer	Version () const
	Returns the Version of the attribute. More...

void	SetVersion (const Standard_Integer version)
	Set the Version of the attribute. More...

void	Clear ()

	~TNaming_NamedShape ()

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

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

virtual void	Restore (const Handle< TDF_Attribute > &anAttribute)
	Restores the contents from <anAttribute> into this <br> one. It is used when aborting a transaction. <br> 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
	Returns an new empty attribute from the good end type. It is used by the copy algorithm. More...

virtual void	Paste (const Handle< TDF_Attribute > &intoAttribute, const Handle< TDF_RelocationTable > &aRelocTationable) const
	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 pastes the current attribute to the label corresponding to the insertor. The pasted attribute may be a brand new one or a new version of the previous one. More...

virtual void	References (const Handle< TDF_DataSet > &aDataSet) const
	Adds the directly referenced attributes and labels to <aDataSet>. "Directly" means we have only to look at the first level of references. More...

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

virtual Standard_Boolean	BeforeUndo (const Handle< TDF_AttributeDelta > &anAttDelta, const Standard_Boolean forceIt=Standard_False)
	Something to do before applying <anAttDelta> More...

virtual Standard_Boolean	AfterUndo (const Handle< TDF_AttributeDelta > &anAttDelta, const Standard_Boolean forceIt=Standard_False)
	Something to do after applying <anAttDelta>. More...

virtual Standard_OStream &	Dump (Standard_OStream &anOS) const
	Dumps the attribute on <aStream>. More...

Public Member Functions inherited from TDF_Attribute
const TDF_Label	Label () const
	Returns the label to which the attribute is <br> attached. If the label is not included in a DF, <br> the label is null. See Label. <br> 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 <br> attribute has been created or modified. <br> 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 <br> backuped or removed one. <br> More...

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

Standard_Boolean	IsForgotten () const
	Returns true if the attribute forgotten status is <br> set. <br> //! ShortCut Methods concerning associated attributes ================================================= 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 <br> to <anID>. the returned <anAttribute> is a valid <br> one. The method returns True if found, False <br> otherwise. A removed attribute cannot be found using <br> this method. 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 carefull 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 mecanisms. Be carefull 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	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 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 <br> flagged "Backuped" and not "Valid". <br> The method does nothing: 1) If the attribute transaction number is equal to the current transaction number (the attribute has already been backuped). 2) If the attribute is not attached to a label. More...

Standard_Boolean	IsBackuped () const
	Returns true if the attribute backup status is <br> set. This status is set/unset by the <br> Backup() method. <br> 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...

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 <br> current transaction in which the forget is done. A <br> forgotten attribute is also flagged not "Valid". <br> A forgotten attribute is invisible. Set also the "Valid" status to False. Obvioulsy, DF cannot empty an attribute (this has a semantic signification), but can remove it from the structure. So, a forgotten attribute is NOT an empty one, but a soon DEAD one. Should be private. More...

Public Member Functions inherited from MMgt_TShared
virtual void	Delete () const
	Memory deallocator for transient classes. 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	ShallowDump (Standard_OStream &) const

virtual const Handle_Standard_Type &	DynamicType () const
	Returns a type information object about this object. More...

Standard_Boolean	IsInstance (const 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 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...

virtual Handle_Standard_Transient	This () const
	Returns a Handle which references this object. Must never be called to objects created in stack. More...

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

Static Public Member Functions
static const Standard_GUID &	GetID ()
	class method ============ //! Returns the GUID for named shapes. More...

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

Detailed Description

The basis to define an attribute for the storage of
topology and naming data.
This attribute contains two parts:

The type of evolution, a term of the
enumeration TNaming_Evolution
A list of pairs of shapes called the "old"
shape and the "new" shape. The meaning
depends on the type of evolution.

Constructor & Destructor Documentation

TNaming_NamedShape::TNaming_NamedShape ( )

TNaming_NamedShape::~TNaming_NamedShape ( )

inline

Member Function Documentation

virtual Standard_Boolean TNaming_NamedShape::AfterUndo	(	const Handle< TDF_AttributeDelta > &	anAttDelta,
		const Standard_Boolean	forceIt = `Standard_False`
	)

virtual

Something to do after applying <anAttDelta>.

Reimplemented from TDF_Attribute.

virtual Handle_TDF_Attribute TNaming_NamedShape::BackupCopy ( ) const

virtual

Copies the attribute contents into a new other
attribute. It is used by Backup().

Reimplemented from TDF_Attribute.

virtual void TNaming_NamedShape::BeforeRemoval ( )

virtual

Something to do before removing an Attribute from
a label.

Reimplemented from TDF_Attribute.

virtual Standard_Boolean TNaming_NamedShape::BeforeUndo	(	const Handle< TDF_AttributeDelta > &	anAttDelta,
		const Standard_Boolean	forceIt = `Standard_False`
	)

virtual

Something to do before applying <anAttDelta>

Reimplemented from TDF_Attribute.

void TNaming_NamedShape::Clear ( )

virtual Handle_TDF_DeltaOnModification TNaming_NamedShape::DeltaOnModification ( const Handle< TDF_Attribute > & anOldAttribute ) const

virtual

Makes a DeltaOnModification between <me> and
<anOldAttribute.

Reimplemented from TDF_Attribute.

virtual void TNaming_NamedShape::DeltaOnModification ( const Handle< TDF_DeltaOnModification > & aDelta )

virtual

Applies a DeltaOnModification to <me>.

Reimplemented from TDF_Attribute.

virtual Handle_TDF_DeltaOnRemoval TNaming_NamedShape::DeltaOnRemoval ( ) const

virtual

Makes a DeltaOnRemoval on <me> because <me> has
disappeared from the DS.

Reimplemented from TDF_Attribute.

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

virtual

Dumps the attribute on <aStream>.

Reimplemented from TDF_Attribute.

TNaming_Evolution TNaming_NamedShape::Evolution ( ) const

Returns the Evolution of the attribute.

TopoDS_Shape TNaming_NamedShape::Get ( ) const

Returns the shapes contained in <NS>. Returns a null
shape if IsEmpty.

static const Standard_GUID& TNaming_NamedShape::GetID ( )

static

class method
============
//! Returns the GUID for named shapes.

const Standard_GUID& TNaming_NamedShape::ID ( ) const

virtual

Returns the ID of the attribute.

Implements TDF_Attribute.

Standard_Boolean TNaming_NamedShape::IsEmpty ( ) const

virtual Handle_TDF_Attribute TNaming_NamedShape::NewEmpty ( ) const

virtual

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

Implements TDF_Attribute.

virtual void TNaming_NamedShape::Paste	(	const Handle< TDF_Attribute > &	intoAttribute,
		const Handle< TDF_RelocationTable > &	aRelocTationable
	)		const

virtual

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 pastes the current attribute to the label
corresponding to the insertor. The pasted
attribute may be a brand new one or a new version
of the previous one.

Implements TDF_Attribute.

virtual void TNaming_NamedShape::References ( const Handle< TDF_DataSet > & aDataSet ) const

virtual

Adds the directly referenced attributes and labels
to <aDataSet>. "Directly" means we have only to
look at the first level of references.

Reimplemented from TDF_Attribute.

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

virtual

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

Implements TDF_Attribute.

void TNaming_NamedShape::SetVersion ( const Standard_Integer version )

Set the Version of the attribute.

Standard_Integer TNaming_NamedShape::Version ( ) const

Returns the Version of the attribute.

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

TNaming_NamedShape.hxx

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation