Open CASCADE Technology  7.4.0
Public Types | Public Member Functions | Static Public Member Functions

TObj_TIntSparseArray Class Reference

#include <TObj_TIntSparseArray.hxx>

Inheritance diagram for TObj_TIntSparseArray:
Inheritance graph
[legend]

Public Types

typedef TObj_TIntSparseArray_VecOfData::ConstIterator Iterator
 
- Public Types inherited from Standard_Transient
typedef void base_type
 Returns a type descriptor about this object. More...
 

Public Member Functions

 TObj_TIntSparseArray ()
 Empty constructor. More...
 
const Standard_GUIDID () const override
 Returns the ID of this attribute. More...
 
Standard_Size Size () const
 Methods for access to data. More...
 
Iterator GetIterator () const
 Returns iterator on objects contained in the set. More...
 
Standard_Boolean HasValue (const Standard_Size theId) const
 Returns true if the value with the given ID is present. More...
 
Standard_Integer Value (const Standard_Size theId) const
 Returns the value by its ID. Raises an exception if no value is stored with this ID. More...
 
void SetValue (const Standard_Size theId, const Standard_Integer theValue)
 Sets the value with the given ID. Raises an exception if theId is not positive. More...
 
void UnsetValue (const Standard_Size theId)
 Unsets the value with the given ID. Raises an exception if theId is not positive. More...
 
void Clear ()
 Clears the set. More...
 
Handle< TDF_AttributeNewEmpty () const override
 Redefined OCAF abstract methods. More...
 
Handle< TDF_AttributeBackupCopy () const override
 Moves this delta into a new other attribute. More...
 
void Restore (const Handle< TDF_Attribute > &theDelta) override
 Restores the set using info saved in backup attribute theDelta. More...
 
void Paste (const Handle< TDF_Attribute > &theInto, const Handle< TDF_RelocationTable > &theRT) const override
 This method is used when copying an attribute from a source structure into a target structure. More...
 
void BeforeCommitTransaction () override
 It is called just before Commit or Abort transaction and does Backup() to create a delta. More...
 
void DeltaOnModification (const Handle< TDF_DeltaOnModification > &theDelta) override
 Applies theDelta to this. More...
 
Standard_Boolean AfterUndo (const Handle< TDF_AttributeDelta > &theDelta, const Standard_Boolean toForce) override
 Clears my modification delta; called after application of theDelta. More...
 
void SetDoBackup (const Standard_Boolean toDo)
 Methods to handle the modification delta. More...
 
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). 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 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 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...
 
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_DeltaOnAdditionDeltaOnAddition () 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_DeltaOnForgetDeltaOnForget () const
 Makes an AttributeDelta because <me> has been forgotten. More...
 
virtual Handle< TDF_DeltaOnResumeDeltaOnResume () const
 Makes an AttributeDelta because <me> has been resumed. More...
 
virtual Handle< TDF_DeltaOnModificationDeltaOnModification (const Handle< TDF_Attribute > &anOldAttribute) const
 Makes a DeltaOnModification between <me> and <anOldAttribute. More...
 
virtual Handle< TDF_DeltaOnRemovalDeltaOnRemoval () const
 Makes a DeltaOnRemoval on <me> because <me> has disappeared from the DS. More...
 
virtual void References (const Handle< TDF_DataSet > &aDataSet) const
 Adds the first level referenced attributes and labels to <aDataSet>. More...
 
virtual Standard_OStreamDump (Standard_OStream &anOS) const
 Dumps the minimum information about <me> on <aStream>. More...
 
Standard_OStreamoperator<< (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_Transientoperator= (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_TransientThis () 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 const Standard_GUIDGetID ()
 This method is used in implementation of ID() More...
 
static Handle< TObj_TIntSparseArraySet (const TDF_Label &theLabel)
 Creates TObj_TIntSparseArray attribute on given label. 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...
 

Additional Inherited Members

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

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 TObj_TIntSparseArray_VecOfData::ConstIterator TObj_TIntSparseArray::Iterator

Constructor & Destructor Documentation

◆ TObj_TIntSparseArray()

TObj_TIntSparseArray::TObj_TIntSparseArray ( )

Empty constructor.

Member Function Documentation

◆ AfterUndo()

Standard_Boolean TObj_TIntSparseArray::AfterUndo ( const Handle< TDF_AttributeDelta > &  theDelta,
const Standard_Boolean  toForce 
)
overridevirtual

Clears my modification delta; called after application of theDelta.

Reimplemented from TDF_Attribute.

◆ BackupCopy()

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

Standard_Boolean TObj_TIntSparseArray::HasValue ( const Standard_Size  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()

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 Handle< TDF_Attribute > &  theInto,
const 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 Handle< TDF_Attribute > &  theDelta)
overridevirtual

Restores the set using info saved in backup attribute theDelta.

Implements TDF_Attribute.

◆ Set()

static Handle< TObj_TIntSparseArray > TObj_TIntSparseArray::Set ( const TDF_Label theLabel)
static

Creates TObj_TIntSparseArray attribute on given label.

◆ SetDoBackup()

void TObj_TIntSparseArray::SetDoBackup ( const Standard_Boolean  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 Standard_Size  theId,
const Standard_Integer  theValue 
)

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

◆ Size()

Standard_Size 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 Standard_Size  theId)

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

◆ Value()

Standard_Integer TObj_TIntSparseArray::Value ( const Standard_Size  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: