Open CASCADE Technology 6.6.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.

#include <TDocStd_XLink.hxx>

Inheritance diagram for TDocStd_XLink:
Inheritance graph
[legend]

Public Member Functions

 TDocStd_XLink ()
 Initializes fields.

Handle_TDF_Reference Update ()
 Updates the data referenced in this external link attribute.

const Standard_GUIDID () const
 Returns the ID of the attribute.


void DocumentEntry (const TCollection_AsciiString &aDocEntry)
 Sets the name aDocEntry for the external
document in this external link attribute.

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

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.

void LabelEntry (const TCollection_AsciiString &aLabEntry)
 Sets the label entry for this external link attribute
as a document identified by aLabEntry.

const TCollection_AsciiStringLabelEntry () const
 Returns the contents of the field <myLabelEntry>.


void AfterAddition ()
 Updates the XLinkRoot attribute by adding <me>
to its list.

void BeforeRemoval ()
 Updates the XLinkRoot attribute by removing <me>
from its list.

virtual Standard_Boolean BeforeUndo (const Handle< TDF_AttributeDelta > &anAttDelta, const Standard_Boolean forceIt=Standard_False)
 Something to do before applying <anAttDelta>.

virtual Standard_Boolean AfterUndo (const Handle< TDF_AttributeDelta > &anAttDelta, const Standard_Boolean forceIt=Standard_False)
 Something to do after applying <anAttDelta>.

Handle_TDF_Attribute BackupCopy () const
 Returns a null handle. Raise allways for ,it is
nonsense to use this method.

void Restore (const Handle< TDF_Attribute > &anAttribute)
 Does nothing.

Handle_TDF_Attribute NewEmpty () const
 Returns a null handle.

void Paste (const Handle< TDF_Attribute > &intoAttribute, const Handle< TDF_RelocationTable > &aRelocationTable) const
 Does nothing.

Standard_OStreamDump (Standard_OStream &anOS) const
 Dumps the attribute on <aStream>.

Static Public Member Functions

static Handle_TDocStd_XLink Set (const TDF_Label &atLabel)
 Sets an empty external reference, at the label aLabel.

static const Standard_GUIDGetID ()
 Returns the GUID for external links.



Constructor & Destructor Documentation

TDocStd_XLink::TDocStd_XLink ( )

Member Function Documentation

void TDocStd_XLink::AfterAddition ( ) [virtual]

Reimplemented from TDF_Attribute.

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

Reimplemented from TDF_Attribute.

Handle_TDF_Attribute TDocStd_XLink::BackupCopy ( ) const [virtual]

Reimplemented from TDF_Attribute.

void TDocStd_XLink::BeforeRemoval ( ) [virtual]

Reimplemented from TDF_Attribute.

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

Reimplemented from TDF_Attribute.

void TDocStd_XLink::DocumentEntry ( const TCollection_AsciiString aDocEntry)
const TCollection_AsciiString& TDocStd_XLink::DocumentEntry ( ) const
Standard_OStream& TDocStd_XLink::Dump ( Standard_OStream anOS) const [virtual]

Reimplemented from TDF_Attribute.

static const Standard_GUID& TDocStd_XLink::GetID ( ) [static]
const Standard_GUID& TDocStd_XLink::ID ( ) const [virtual]

Implements TDF_Attribute.

void TDocStd_XLink::LabelEntry ( const TDF_Label aLabel)
void TDocStd_XLink::LabelEntry ( const TCollection_AsciiString aLabEntry)
const TCollection_AsciiString& TDocStd_XLink::LabelEntry ( ) const
Handle_TDF_Attribute TDocStd_XLink::NewEmpty ( ) const [virtual]

Implements TDF_Attribute.

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

Implements TDF_Attribute.

void TDocStd_XLink::Restore ( const Handle< TDF_Attribute > &  anAttribute) [virtual]

Implements TDF_Attribute.

static Handle_TDocStd_XLink TDocStd_XLink::Set ( const TDF_Label atLabel) [static]
Handle_TDF_Reference TDocStd_XLink::Update ( )

The documentation for this class was generated from the following file:
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines