Provides links between functions. More...
#include <TFunction_GraphNode.hxx>
Inheritance diagram for TFunction_GraphNode:
Public Member Functions | |
| TFunction_GraphNode () | |
| Standard_Boolean | AddPrevious (const Standard_Integer funcID) |
| Defines a reference to the function as a previous one. More... | |
| Standard_Boolean | AddPrevious (const TDF_Label &func) |
| Defines a reference to the function as a previous one. More... | |
| Standard_Boolean | RemovePrevious (const Standard_Integer funcID) |
| Removes a reference to the function as a previous one. More... | |
| Standard_Boolean | RemovePrevious (const TDF_Label &func) |
| Removes a reference to the function as a previous one. More... | |
| const TColStd_MapOfInteger & | GetPrevious () const |
| Returns a map of previous functions. More... | |
| void | RemoveAllPrevious () |
| Clears a map of previous functions. More... | |
| Standard_Boolean | AddNext (const Standard_Integer funcID) |
| Defines a reference to the function as a next one. More... | |
| Standard_Boolean | AddNext (const TDF_Label &func) |
| Defines a reference to the function as a next one. More... | |
| Standard_Boolean | RemoveNext (const Standard_Integer funcID) |
| Removes a reference to the function as a next one. More... | |
| Standard_Boolean | RemoveNext (const TDF_Label &func) |
| Removes a reference to the function as a next one. More... | |
| const TColStd_MapOfInteger & | GetNext () const |
| Returns a map of next functions. More... | |
| void | RemoveAllNext () |
| Clears a map of next functions. More... | |
| TFunction_ExecutionStatus | GetStatus () const |
| Returns the execution status of the function. More... | |
| void | SetStatus (const TFunction_ExecutionStatus status) |
| Defines an execution status for a function. <>Implementation of Attribute methods
More... | |
| const Standard_GUID & | ID () 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_Attribute > | NewEmpty () const override |
| Returns an new empty attribute from the good end type. It is used by the copy algorithm. More... | |
| virtual void | References (const Handle< TDF_DataSet > &aDataSet) const override |
| Adds the first level referenced attributes and labels to <aDataSet>. More... | |
| virtual Standard_OStream & | Dump (Standard_OStream &anOS) const override |
| Dumps the minimum information about <me> on <aStream>. More... | |
 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... | |
| 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_Attribute > | BackupCopy () const |
| Copies the attribute contents into a new other attribute. It is used by Backup(). 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... | |
| 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... | |
| 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 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_Transient & | operator= (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_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. 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_GraphNode > | Set (const TDF_Label &L) |
| <>Static methods
Finds or Creates a graph node attribute at the label <L>. Returns the attribute. More... | |
| static const Standard_GUID & | GetID () |
| Returns the GUID for GraphNode attribute. <>Instant methods
Constructor (empty). 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
Provides links between functions.
Constructor & Destructor Documentation
◆ TFunction_GraphNode()
| TFunction_GraphNode::TFunction_GraphNode | ( | ) |
Member Function Documentation
◆ AddNext() [1/2]
| Standard_Boolean TFunction_GraphNode::AddNext | ( | const Standard_Integer | funcID | ) |
Defines a reference to the function as a next one.
◆ AddNext() [2/2]
| Standard_Boolean TFunction_GraphNode::AddNext | ( | const TDF_Label & | func | ) |
Defines a reference to the function as a next one.
◆ AddPrevious() [1/2]
| Standard_Boolean TFunction_GraphNode::AddPrevious | ( | const Standard_Integer | funcID | ) |
Defines a reference to the function as a previous one.
◆ AddPrevious() [2/2]
| Standard_Boolean TFunction_GraphNode::AddPrevious | ( | const TDF_Label & | func | ) |
Defines a reference to the function as a previous one.
◆ Dump()
|
overridevirtual |
Dumps the minimum information about <me> on <aStream>.
Reimplemented from TDF_Attribute.
◆ GetID()
|
static |
Returns the GUID for GraphNode attribute.
<>Instant methods Constructor (empty).◆ GetNext()
| const TColStd_MapOfInteger& TFunction_GraphNode::GetNext | ( | ) | const |
Returns a map of next functions.
◆ GetPrevious()
| const TColStd_MapOfInteger& TFunction_GraphNode::GetPrevious | ( | ) | const |
Returns a map of previous functions.
◆ GetStatus()
| TFunction_ExecutionStatus TFunction_GraphNode::GetStatus | ( | ) | const |
Returns the execution status of the function.
◆ ID()
|
overridevirtual |
Returns the ID of the attribute.
Implements TDF_Attribute.
◆ NewEmpty()
|
overridevirtual |
Returns an new empty attribute from the good end type. It is used by the copy algorithm.
Implements TDF_Attribute.
◆ Paste()
|
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()
|
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.
◆ RemoveAllNext()
| void TFunction_GraphNode::RemoveAllNext | ( | ) |
Clears a map of next functions.
◆ RemoveAllPrevious()
| void TFunction_GraphNode::RemoveAllPrevious | ( | ) |
Clears a map of previous functions.
◆ RemoveNext() [1/2]
| Standard_Boolean TFunction_GraphNode::RemoveNext | ( | const Standard_Integer | funcID | ) |
Removes a reference to the function as a next one.
◆ RemoveNext() [2/2]
| Standard_Boolean TFunction_GraphNode::RemoveNext | ( | const TDF_Label & | func | ) |
Removes a reference to the function as a next one.
◆ RemovePrevious() [1/2]
| Standard_Boolean TFunction_GraphNode::RemovePrevious | ( | const Standard_Integer | funcID | ) |
Removes a reference to the function as a previous one.
◆ RemovePrevious() [2/2]
| Standard_Boolean TFunction_GraphNode::RemovePrevious | ( | const TDF_Label & | func | ) |
Removes a reference to the function as a previous one.
◆ Restore()
|
overridevirtual |
Restores the backuped contents from <anAttribute> into this one. It is used when aborting a transaction.
Implements TDF_Attribute.
◆ Set()
|
static |
<>Static methods Finds or Creates a graph node attribute at the label <L>. Returns the attribute.
◆ SetStatus()
| void TFunction_GraphNode::SetStatus | ( | const TFunction_ExecutionStatus | status | ) |
Defines an execution status for a function.
<>Implementation of Attribute methodsThe documentation for this class was generated from the following file:
