#include <TObj_TIntSparseArray.hxx>

Inheritance diagram for TObj_TIntSparseArray:

[legend]

Public Types
typedef NCollection_SparseArray< int >::ConstIterator	Iterator

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

Public Member Functions
	TObj_TIntSparseArray ()
	Empty constructor.

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

size_t	Size () const
	Methods for access to data.

Iterator	GetIterator () const
	Returns iterator on objects contained in the set.

bool	HasValue (const size_t theId) const
	Returns true if the value with the given ID is present.

int	Value (const size_t theId) const
	Returns the value by its ID. Raises an exception if no value is stored with this ID.

void	SetValue (const size_t theId, const int theValue)
	Sets the value with the given ID. Raises an exception if theId is not positive.

void	UnsetValue (const size_t theId)
	Unsets the value with the given ID. Raises an exception if theId is not positive.

void	Clear ()
	Clears the set.

occ::handle< TDF_Attribute >	NewEmpty () const override
	Redefined OCAF abstract methods.

occ::handle< TDF_Attribute >	BackupCopy () const override
	Moves this delta into a new other attribute.

void	Restore (const occ::handle< TDF_Attribute > &theDelta) override
	Restores the set using info saved in backup attribute theDelta.

void	Paste (const occ::handle< TDF_Attribute > &theInto, const occ::handle< TDF_RelocationTable > &theRT) const override
	This method is used when copying an attribute from a source structure into a target structure.

void	BeforeCommitTransaction () override
	It is called just before Commit or Abort transaction and does Backup() to create a delta.

void	DeltaOnModification (const occ::handle< TDF_DeltaOnModification > &theDelta) override
	Applies theDelta to this.

bool	AfterUndo (const occ::handle< TDF_AttributeDelta > &theDelta, const bool toForce) override
	Clears my modification delta; called after application of theDelta.

void	SetDoBackup (const bool toDo)
	Methods to handle the modification delta.

void	ClearDelta ()

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

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_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 occ::handle< TDF_DeltaOnRemoval >	DeltaOnRemoval () const
	Makes a DeltaOnRemoval on <me> because <me> has disappeared from the DS.

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

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

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

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

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 const Standard_GUID &	GetID ()
	This method is used in implementation of ID()

static occ::handle< TObj_TIntSparseArray >	Set (const TDF_Label &theLabel)
	Creates TObj_TIntSparseArray attribute on given label.

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
Protected Member Functions inherited from TDF_Attribute
	TDF_Attribute ()
	Initializes fields.

Detailed Description

OCAF Attribute to store a set of positive integer values in the OCAF tree. Each value is identified by ID (positive integer). The supporting underlying data structure is NCollection_SparseArray of integers.

Member Typedef Documentation

◆ Iterator

typedef NCollection_SparseArray<int>::ConstIterator TObj_TIntSparseArray::Iterator

Constructor & Destructor Documentation

◆ TObj_TIntSparseArray()

TObj_TIntSparseArray::TObj_TIntSparseArray ( )

Empty constructor.

Member Function Documentation

◆ AfterUndo()

bool TObj_TIntSparseArray::AfterUndo	(	const occ::handle< TDF_AttributeDelta > &	theDelta,
		const bool	toForce )

overridevirtual

Clears my modification delta; called after application of theDelta.

Reimplemented from TDF_Attribute.

◆ BackupCopy()

occ::handle< TDF_Attribute > TObj_TIntSparseArray::BackupCopy ( ) const

overridevirtual

Moves this delta into a new other attribute.

Reimplemented from TDF_Attribute.

◆ BeforeCommitTransaction()

void TObj_TIntSparseArray::BeforeCommitTransaction ( )

overridevirtual

It is called just before Commit or Abort transaction and does Backup() to create a delta.

Reimplemented from TDF_Attribute.

◆ Clear()

void TObj_TIntSparseArray::Clear ( )

Clears the set.

◆ ClearDelta()

void TObj_TIntSparseArray::ClearDelta ( )

inline

◆ DeltaOnModification()

void TObj_TIntSparseArray::DeltaOnModification ( const occ::handle< TDF_DeltaOnModification > & theDelta )

overridevirtual

Applies theDelta to this.

Reimplemented from TDF_Attribute.

◆ GetID()

static const Standard_GUID & TObj_TIntSparseArray::GetID ( )

static

This method is used in implementation of ID()

◆ GetIterator()

Iterator TObj_TIntSparseArray::GetIterator ( ) const

inline

Returns iterator on objects contained in the set.

◆ HasValue()

bool TObj_TIntSparseArray::HasValue ( const size_t theId ) const

inline

Returns true if the value with the given ID is present.

◆ ID()

const Standard_GUID & TObj_TIntSparseArray::ID ( ) const

overridevirtual

Returns the ID of this attribute.

Implements TDF_Attribute.

◆ NewEmpty()

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

overridevirtual

Redefined OCAF abstract methods.

Returns an new empty TObj_TIntSparseArray attribute. It is used by the copy algorithm.

Implements TDF_Attribute.

◆ Paste()

void TObj_TIntSparseArray::Paste	(	const occ::handle< TDF_Attribute > &	theInto,
		const occ::handle< TDF_RelocationTable > &	theRT ) const

overridevirtual

This method is used when copying an attribute from a source structure into a target structure.

Implements TDF_Attribute.

◆ Restore()

void TObj_TIntSparseArray::Restore ( const occ::handle< TDF_Attribute > & theDelta )

overridevirtual

Restores the set using info saved in backup attribute theDelta.

Implements TDF_Attribute.

◆ Set()

static occ::handle< TObj_TIntSparseArray > TObj_TIntSparseArray::Set ( const TDF_Label & theLabel )

static

Creates TObj_TIntSparseArray attribute on given label.

◆ SetDoBackup()

void TObj_TIntSparseArray::SetDoBackup ( const bool toDo )

inline

Methods to handle the modification delta.

Sets the flag pointing to the necessity to maintain a modification delta. It is called by the retrieval driver

◆ SetValue()

void TObj_TIntSparseArray::SetValue	(	const size_t	theId,
		const int	theValue )

Sets the value with the given ID. Raises an exception if theId is not positive.

◆ Size()

size_t TObj_TIntSparseArray::Size ( ) const

inline

Methods for access to data.

Returns the number of stored values in the set

◆ UnsetValue()

void TObj_TIntSparseArray::UnsetValue ( const size_t theId )

Unsets the value with the given ID. Raises an exception if theId is not positive.

◆ Value()

int TObj_TIntSparseArray::Value ( const size_t theId ) const

inline

Returns the value by its ID. Raises an exception if no value is stored with this ID.

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

TObj_TIntSparseArray.hxx

Public Types

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Iterator

Constructor & Destructor Documentation

◆ TObj_TIntSparseArray()

Member Function Documentation

◆ AfterUndo()

◆ BackupCopy()

◆ BeforeCommitTransaction()

◆ Clear()

◆ ClearDelta()

◆ DeltaOnModification()

◆ GetID()

◆ GetIterator()

◆ HasValue()

◆ ID()

◆ NewEmpty()

◆ Paste()

◆ Restore()

◆ Set()

◆ SetDoBackup()

◆ SetValue()

◆ Size()

◆ UnsetValue()

◆ Value()