#include <TObj_TNameContainer.hxx>
Inheritance diagram for TObj_TNameContainer:
Public Member Functions | |
| TObj_TNameContainer () | |
| Standard methods of OCAF attribute. | |
| const Standard_GUID & | ID () const override |
| Returns the ID of TObj_TNameContainer attribute. | |
| void | RecordName (const Handle< TCollection_HExtendedString > &theName, const TDF_Label &theLabel) |
| Methods for adding and removing names. | |
| void | RemoveName (const Handle< TCollection_HExtendedString > &theName) |
| Remove name from the map. | |
| Standard_Boolean | IsRegistered (const Handle< TCollection_HExtendedString > &theName) const |
| Return True is theName is registered in the Map. | |
| void | Clear () |
| Remove all names registered in container. | |
| void | Set (const TObj_DataMapOfNameLabel &theElem) |
| Methods for setting and obtaining TObj_TNameContainer. | |
| const TObj_DataMapOfNameLabel & | Get () const |
| Returns the TObj_DataMapOfNameLabel object. | |
| Handle< TDF_Attribute > | NewEmpty () const override |
| Redefined OCAF abstract methods. | |
| void | Restore (const Handle< TDF_Attribute > &theWith) override |
| Restores the backuped contents from <theWith> into this one. It is used when aborting a transaction. | |
| 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. | |
 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. | |
| Standard_Integer | Transaction () const |
| Returns the transaction index in which the attribute has been created or modified. | |
| 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. | |
| Standard_Boolean | IsValid () const |
| Returns true if the attribute is valid; i.e. not a backuped or removed one. | |
| Standard_Boolean | IsNew () const |
| Returns true if the attribute has no backup. | |
| Standard_Boolean | IsForgotten () const |
| Returns true if the attribute forgotten status is set. | |
| Standard_Boolean | IsAttribute (const Standard_GUID &anID) const |
| Returns true if it exists an associated attribute of <me> with <anID> as ID. | |
| 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. | |
| template<class T > | |
| Standard_Boolean | FindAttribute (const Standard_GUID &theID, Handle< T > &theAttr) const |
| Safe variant for arbitrary type of argument. | |
| 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>. | |
| 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. | |
| 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. | |
| 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 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. | |
| 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. | |
| 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. | |
| virtual void | BeforeCommitTransaction () |
| A callback. By default does nothing. It is called by TDF_Data::CommitTransaction() method. | |
| void | Backup () |
| Backups the attribute. The backuped attribute is flagged "Backuped" and not "Valid". | |
| Standard_Boolean | IsBackuped () const |
| Returns true if the attribute backup status is set. This status is set/unset by the Backup() method. | |
| virtual Handle< TDF_Attribute > | BackupCopy () const |
| Copies the attribute contents into a new other attribute. It is used by Backup(). | |
| 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). | |
| virtual Handle< TDF_DeltaOnForget > | DeltaOnForget () const |
| Makes an AttributeDelta because <me> has been forgotten. | |
| virtual Handle< TDF_DeltaOnResume > | DeltaOnResume () const |
| Makes an AttributeDelta because <me> has been resumed. | |
| virtual Handle< TDF_DeltaOnModification > | DeltaOnModification (const Handle< TDF_Attribute > &anOldAttribute) const |
| Makes a DeltaOnModification between <me> and. | |
| virtual void | DeltaOnModification (const Handle< TDF_DeltaOnModification > &aDelta) |
| Applies a DeltaOnModification to <me>. | |
| virtual Handle< TDF_DeltaOnRemoval > | DeltaOnRemoval () const |
| Makes a DeltaOnRemoval on <me> because <me> has disappeared from the DS. | |
| virtual void | References (const 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, 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. | |
| 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". | |
| virtual void | DumpJson (Standard_OStream &theOStream, Standard_Integer 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 () |
| Destructor must be virtual. | |
| virtual const opencascade::handle< Standard_Type > & | DynamicType () const |
| Returns a type descriptor about this object. | |
| Standard_Boolean | IsInstance (const opencascade::handle< Standard_Type > &theType) const |
| Returns a true value if this is an instance of Type. | |
| Standard_Boolean | IsInstance (const Standard_CString theTypeName) const |
| Returns a true value if this is an instance of TypeName. | |
| 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. | |
| 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. | |
| 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. | |
| Standard_Integer | GetRefCount () const noexcept |
| Get the reference counter of this object. | |
| void | IncrementRefCounter () noexcept |
| Increments the reference counter of this object. | |
| Standard_Integer | DecrementRefCounter () noexcept |
| Decrements the reference counter of this object; returns the decremented value. | |
| 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 Handle< TObj_TNameContainer > | Set (const TDF_Label &theLabel) |
| Method for create TObj_TNameContainer object. | |
| 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 | |
| Public Types inherited from Standard_Transient | |
| typedef void | base_type |
| Returns a type descriptor about this object. | |
| Protected Member Functions inherited from TDF_Attribute | |
| TDF_Attribute () | |
| Initializes fields. | |
Detailed Description
This class provides OCAF Attribute to storing the unique names of object in model.
Constructor & Destructor Documentation
◆ TObj_TNameContainer()
| TObj_TNameContainer::TObj_TNameContainer | ( | ) |
Standard methods of OCAF attribute.
Empty constructor
Member Function Documentation
◆ Clear()
| void TObj_TNameContainer::Clear | ( | ) |
Remove all names registered in container.
◆ Get()
| const TObj_DataMapOfNameLabel & TObj_TNameContainer::Get | ( | ) | const |
Returns the TObj_DataMapOfNameLabel object.
◆ GetID()
|
static |
This method is used in implementation of ID()
◆ ID()
|
overridevirtual |
Returns the ID of TObj_TNameContainer attribute.
Implements TDF_Attribute.
◆ IsRegistered()
| Standard_Boolean TObj_TNameContainer::IsRegistered | ( | const Handle< TCollection_HExtendedString > & | theName | ) | const |
Return True is theName is registered in the Map.
◆ NewEmpty()
|
overridevirtual |
Redefined OCAF abstract methods.
Returns an new empty TObj_TNameContainer attribute. It is used by the copy algorithm.
Implements TDF_Attribute.
◆ Paste()
|
overridevirtual |
This method is used when copying an attribute from a source structure into a target structure.
Implements TDF_Attribute.
◆ RecordName()
| void TObj_TNameContainer::RecordName | ( | const Handle< TCollection_HExtendedString > & | theName, |
| const TDF_Label & | theLabel | ||
| ) |
Methods for adding and removing names.
Records name with label attached
◆ RemoveName()
| void TObj_TNameContainer::RemoveName | ( | const Handle< TCollection_HExtendedString > & | theName | ) |
Remove name from the map.
◆ Restore()
|
overridevirtual |
Restores the backuped contents from <theWith> into this one. It is used when aborting a transaction.
Implements TDF_Attribute.
◆ Set() [1/2]
|
static |
Method for create TObj_TNameContainer object.
Creates TObj_DataMapOfNameLabel attribute on given label if not exist
◆ Set() [2/2]
| void TObj_TNameContainer::Set | ( | const TObj_DataMapOfNameLabel & | theElem | ) |
Methods for setting and obtaining TObj_TNameContainer.
Sets the TObj_DataMapOfNameLabel object
The documentation for this class was generated from the following file:
