Open CASCADE Technology  7.7.0.dev
Public Member Functions | Static Public Member Functions

TFunction_Scope Class Reference

Keeps a scope of functions. More...

#include <TFunction_Scope.hxx>

Inheritance diagram for TFunction_Scope:
Inheritance graph
[legend]

Public Member Functions

 TFunction_Scope ()
 
Standard_Boolean AddFunction (const TDF_Label &L)
 Adds a function to the scope of functions. More...
 
Standard_Boolean RemoveFunction (const TDF_Label &L)
 Removes a function from the scope of functions. More...
 
Standard_Boolean RemoveFunction (const Standard_Integer ID)
 Removes a function from the scope of functions. More...
 
void RemoveAllFunctions ()
 Removes all functions from the scope of functions. More...
 
Standard_Boolean HasFunction (const Standard_Integer ID) const
 Returns true if the function exists with such an ID. More...
 
Standard_Boolean HasFunction (const TDF_Label &L) const
 Returns true if the label contains a function of this scope. More...
 
Standard_Integer GetFunction (const TDF_Label &L) const
 Returns an ID of the function. More...
 
const TDF_LabelGetFunction (const Standard_Integer ID) const
 Returns the label of the function with this ID. More...
 
Handle< TFunction_LogbookGetLogbook () const
 Returns the Logbook used in TFunction_Driver methods. More...
 
const Standard_GUIDID () const override
 Returns the ID of the attribute. More...
 
virtual void Restore (const Handle< TDF_Attribute > &with) override
 Restores the backuped contents from <anAttribute> into this one. It is used when aborting a transaction. More...
 
virtual 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>. More...
 
virtual Handle< TDF_AttributeNewEmpty () const override
 Returns an new empty attribute from the good end type. It is used by the copy algorithm. More...
 
virtual Standard_OStreamDump (Standard_OStream &anOS) const override
 Dumps the minimum information about <me> on <aStream>. More...
 
const TFunction_DoubleMapOfIntegerLabelGetFunctions () const
 Returns the scope of functions. More...
 
TFunction_DoubleMapOfIntegerLabelChangeFunctions ()
 Returns the scope of functions for modification. Warning: Don't use this method if You are not sure what You do! More...
 
void SetFreeID (const Standard_Integer ID)
 
Standard_Integer GetFreeID () const
 
- 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 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. 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 mechanisms. Be careful 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...
 
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. 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 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_AttributeBackupCopy () const
 Copies the attribute contents into a new other attribute. It is used by Backup(). 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 void DeltaOnModification (const Handle< TDF_DeltaOnModification > &aDelta)
 Applies a DeltaOnModification to <me>. 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...
 
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...
 
virtual void DumpJson (Standard_OStream &theOStream, Standard_Integer theDepth=-1) const
 Dumps the content of me into the stream. 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 Handle< TFunction_ScopeSet (const TDF_Label &Access)
 
static const Standard_GUIDGetID ()
 Returns the GUID for Scope attribute. 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

- Public Types inherited from Standard_Transient
typedef void base_type
 Returns a type descriptor about this object. More...
 
- Protected Member Functions inherited from TDF_Attribute
 TDF_Attribute ()
 Initializes fields. More...
 

Detailed Description

Keeps a scope of functions.

Constructor & Destructor Documentation

◆ TFunction_Scope()

TFunction_Scope::TFunction_Scope ( )

Member Function Documentation

◆ AddFunction()

Standard_Boolean TFunction_Scope::AddFunction ( const TDF_Label L)

Adds a function to the scope of functions.

◆ ChangeFunctions()

TFunction_DoubleMapOfIntegerLabel& TFunction_Scope::ChangeFunctions ( )

Returns the scope of functions for modification. Warning: Don't use this method if You are not sure what You do!

◆ Dump()

virtual Standard_OStream& TFunction_Scope::Dump ( Standard_OStream anOS) const
overridevirtual

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

Reimplemented from TDF_Attribute.

◆ GetFreeID()

Standard_Integer TFunction_Scope::GetFreeID ( ) const

◆ GetFunction() [1/2]

const TDF_Label& TFunction_Scope::GetFunction ( const Standard_Integer  ID) const

Returns the label of the function with this ID.

◆ GetFunction() [2/2]

Standard_Integer TFunction_Scope::GetFunction ( const TDF_Label L) const

Returns an ID of the function.

◆ GetFunctions()

const TFunction_DoubleMapOfIntegerLabel& TFunction_Scope::GetFunctions ( ) const

Returns the scope of functions.

◆ GetID()

static const Standard_GUID& TFunction_Scope::GetID ( )
static

Returns the GUID for Scope attribute.

<> Instant methods

Constructor (empty).

◆ GetLogbook()

Handle< TFunction_Logbook > TFunction_Scope::GetLogbook ( ) const

Returns the Logbook used in TFunction_Driver methods.

<> Implementation of Attribute methods

◆ HasFunction() [1/2]

Standard_Boolean TFunction_Scope::HasFunction ( const Standard_Integer  ID) const

Returns true if the function exists with such an ID.

◆ HasFunction() [2/2]

Standard_Boolean TFunction_Scope::HasFunction ( const TDF_Label L) const

Returns true if the label contains a function of this scope.

◆ ID()

const Standard_GUID& TFunction_Scope::ID ( ) const
overridevirtual

Returns the ID of the attribute.

Implements TDF_Attribute.

◆ NewEmpty()

virtual Handle< TDF_Attribute > TFunction_Scope::NewEmpty ( ) const
overridevirtual

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

Implements TDF_Attribute.

◆ Paste()

virtual void TFunction_Scope::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.

◆ RemoveAllFunctions()

void TFunction_Scope::RemoveAllFunctions ( )

Removes all functions from the scope of functions.

◆ RemoveFunction() [1/2]

Standard_Boolean TFunction_Scope::RemoveFunction ( const Standard_Integer  ID)

Removes a function from the scope of functions.

◆ RemoveFunction() [2/2]

Standard_Boolean TFunction_Scope::RemoveFunction ( const TDF_Label L)

Removes a function from the scope of functions.

◆ Restore()

virtual void TFunction_Scope::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.

◆ Set()

static Handle< TFunction_Scope > TFunction_Scope::Set ( const TDF_Label Access)
static
<> Static methods

Finds or Creates a TFunction_Scope attribute at the root label accessed by <Access>. Returns the attribute.

◆ SetFreeID()

void TFunction_Scope::SetFreeID ( const Standard_Integer  ID)

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