Open CASCADE Technology  7.3.0
Public Member Functions | Static Public Member Functions

TDocStd_XLink Class Reference

An attribute to store the path and the entry of external links. These refer from one data structure to a data structure in another document. More...

#include <TDocStd_XLink.hxx>

Inheritance diagram for TDocStd_XLink:
Inheritance graph
[legend]

Public Member Functions

 TDocStd_XLink ()
 Initializes fields. More...
 
Handle< TDF_ReferenceUpdate ()
 Updates the data referenced in this external link attribute. More...
 
const Standard_GUIDID () const override
 Returns the ID of the attribute. More...
 
void DocumentEntry (const TCollection_AsciiString &aDocEntry)
 Sets the name aDocEntry for the external document in this external link attribute. More...
 
const TCollection_AsciiStringDocumentEntry () const
 Returns the contents of the document identified by aDocEntry. aDocEntry provides external data to this external link attribute. More...
 
void LabelEntry (const TDF_Label &aLabel)
 Sets the label entry for this external link attribute with the label aLabel. aLabel pilots the importation of data from the document entry. More...
 
void LabelEntry (const TCollection_AsciiString &aLabEntry)
 Sets the label entry for this external link attribute as a document identified by aLabEntry. More...
 
const TCollection_AsciiStringLabelEntry () const
 Returns the contents of the field <myLabelEntry>. More...
 
void AfterAddition () override
 Updates the XLinkRoot attribute by adding <me> to its list. More...
 
void BeforeRemoval () override
 Updates the XLinkRoot attribute by removing <me> from its list. More...
 
virtual Standard_Boolean BeforeUndo (const Handle< TDF_AttributeDelta > &anAttDelta, const Standard_Boolean forceIt=Standard_False) override
 Something to do before applying <anAttDelta>. More...
 
virtual Standard_Boolean AfterUndo (const Handle< TDF_AttributeDelta > &anAttDelta, const Standard_Boolean forceIt=Standard_False) override
 Something to do after applying <anAttDelta>. More...
 
Handle< TDF_AttributeBackupCopy () const override
 Returns a null handle. Raise allways for ,it is nonsense to use this method. More...
 
void Restore (const Handle< TDF_Attribute > &anAttribute) override
 Does nothing. More...
 
Handle< TDF_AttributeNewEmpty () const override
 Returns a null handle. More...
 
void Paste (const Handle< TDF_Attribute > &intoAttribute, const Handle< TDF_RelocationTable > &aRelocationTable) const override
 Does nothing. More...
 
Standard_OStreamDump (Standard_OStream &anOS) const override
 Dumps the attribute 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 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 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_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...
 
- 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< TDocStd_XLinkSet (const TDF_Label &atLabel)
 Sets an empty external reference, at the label aLabel. More...
 
static const Standard_GUIDGetID ()
 Returns the GUID for external links. 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

An attribute to store the path and the entry of external links. These refer from one data structure to a data structure in another document.

Constructor & Destructor Documentation

◆ TDocStd_XLink()

TDocStd_XLink::TDocStd_XLink ( )

Initializes fields.

Member Function Documentation

◆ AfterAddition()

void TDocStd_XLink::AfterAddition ( )
overridevirtual

Updates the XLinkRoot attribute by adding <me> to its list.

Reimplemented from TDF_Attribute.

◆ AfterUndo()

virtual Standard_Boolean TDocStd_XLink::AfterUndo ( const Handle< TDF_AttributeDelta > &  anAttDelta,
const Standard_Boolean  forceIt = Standard_False 
)
overridevirtual

Something to do after applying <anAttDelta>.

Reimplemented from TDF_Attribute.

◆ BackupCopy()

Handle< TDF_Attribute > TDocStd_XLink::BackupCopy ( ) const
overridevirtual

Returns a null handle. Raise allways for ,it is nonsense to use this method.

Reimplemented from TDF_Attribute.

◆ BeforeRemoval()

void TDocStd_XLink::BeforeRemoval ( )
overridevirtual

Updates the XLinkRoot attribute by removing <me> from its list.

Reimplemented from TDF_Attribute.

◆ BeforeUndo()

virtual Standard_Boolean TDocStd_XLink::BeforeUndo ( const Handle< TDF_AttributeDelta > &  anAttDelta,
const Standard_Boolean  forceIt = Standard_False 
)
overridevirtual

Something to do before applying <anAttDelta>.

Reimplemented from TDF_Attribute.

◆ DocumentEntry() [1/2]

void TDocStd_XLink::DocumentEntry ( const TCollection_AsciiString aDocEntry)

Sets the name aDocEntry for the external document in this external link attribute.

◆ DocumentEntry() [2/2]

const TCollection_AsciiString& TDocStd_XLink::DocumentEntry ( ) const

Returns the contents of the document identified by aDocEntry. aDocEntry provides external data to this external link attribute.

◆ Dump()

Standard_OStream& TDocStd_XLink::Dump ( Standard_OStream anOS) const
overridevirtual

Dumps the attribute on <aStream>.

Reimplemented from TDF_Attribute.

◆ GetID()

static const Standard_GUID& TDocStd_XLink::GetID ( )
static

Returns the GUID for external links.

◆ ID()

const Standard_GUID& TDocStd_XLink::ID ( ) const
overridevirtual

Returns the ID of the attribute.

Implements TDF_Attribute.

◆ LabelEntry() [1/3]

void TDocStd_XLink::LabelEntry ( const TDF_Label aLabel)

Sets the label entry for this external link attribute with the label aLabel. aLabel pilots the importation of data from the document entry.

◆ LabelEntry() [2/3]

void TDocStd_XLink::LabelEntry ( const TCollection_AsciiString aLabEntry)

Sets the label entry for this external link attribute as a document identified by aLabEntry.

◆ LabelEntry() [3/3]

const TCollection_AsciiString& TDocStd_XLink::LabelEntry ( ) const

Returns the contents of the field <myLabelEntry>.

◆ NewEmpty()

Handle< TDF_Attribute > TDocStd_XLink::NewEmpty ( ) const
overridevirtual

Returns a null handle.

Implements TDF_Attribute.

◆ Paste()

void TDocStd_XLink::Paste ( const Handle< TDF_Attribute > &  intoAttribute,
const Handle< TDF_RelocationTable > &  aRelocationTable 
) const
overridevirtual

Does nothing.

Implements TDF_Attribute.

◆ Restore()

void TDocStd_XLink::Restore ( const Handle< TDF_Attribute > &  anAttribute)
overridevirtual

Does nothing.

Implements TDF_Attribute.

◆ Set()

static Handle< TDocStd_XLink > TDocStd_XLink::Set ( const TDF_Label atLabel)
static

Sets an empty external reference, at the label aLabel.

◆ Update()

Handle< TDF_Reference > TDocStd_XLink::Update ( )

Updates the data referenced in this external link attribute.


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