TObj_TReference Class Reference

#include <TObj_TReference.hxx>

Inheritance diagram for TObj_TReference:

Public Member Functions
	TObj_TReference ()
	Standard methods of OCAF attribute.
const Standard_GUID &	ID () const
	Returns the ID of TObj_TReference attribute.
void	Set (const Handle< TObj_Object > &theObject, const TDF_Label &theMasterLabel)
	Methods for setting and obtaining referenced object.
void	Set (const TDF_Label &theLabel, const TDF_Label &theMasterLabel)
	Sets the reference to the theObject at indicated Label. It is method for persistent only. Don`t use anywhere else.
Handle< TObj_Object >	Get () const
	Returns the referenced theObject.
TDF_Label	GetMasterLabel () const
	Returns the Label of master object.
TDF_Label	GetLabel () const
	Returns the referred label.
Handle< TDF_Attribute >	NewEmpty () const
	Redefined OCAF abstract methods.
void	Restore (const Handle< TDF_Attribute > &theWith)
	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
	This method is used when copying an attribute from a source structure into a target structure.
virtual void	BeforeForget ()
	Remove back references of it reference if it is in other document.
virtual Standard_Boolean	BeforeUndo (const Handle< TDF_AttributeDelta > &theDelta, const Standard_Boolean isForced=Standard_False)
	It is necessary for tranzaction mechanism (Undo/Redo).
virtual Standard_Boolean	AfterUndo (const Handle< TDF_AttributeDelta > &theDelta, const Standard_Boolean isForced=Standard_False)
	It is necessary for tranzaction mechanism (Undo/Redo).
virtual void	AfterResume ()
	Check if back reference exists for reference.
virtual Standard_Boolean	AfterRetrieval (const Standard_Boolean forceIt=Standard_False)
	Called after retrieval reference from file.
Static Public Member Functions
static const Standard_GUID &	GetID ()
	This method is used in implementation of ID()
static Handle< TObj_TReference >	Set (const TDF_Label &theLabel, const Handle< TObj_Object > &theObject, const Handle< TObj_Object > &theMaster)
	Method for create TObj_TReference object.

---

Detailed Description

Attribute for storing references to the objects which implement TObj_Object interface in the OCAF tree. Its persistency mechanism provides transparent method for storing cross-model references. Each reference, when created, registers itself in the referred object, to support back references

---

Constructor & Destructor Documentation

TObj_TReference::TObj_TReference

(

)

Empty constructor

---

Member Function Documentation

virtual void TObj_TReference::AfterResume

(

)

[virtual]

Reimplemented from TDF_Attribute.

virtual Standard_Boolean TObj_TReference::AfterRetrieval

(

const Standard_Boolean

forceIt = Standard_False

)

[virtual]

Reimplemented from TDF_Attribute.

virtual Standard_Boolean TObj_TReference::AfterUndo	(	const Handle< TDF_AttributeDelta > &	theDelta,
		const Standard_Boolean	isForced = Standard_False
	)		[virtual]

Reimplemented from TDF_Attribute.

virtual void TObj_TReference::BeforeForget

(

)

[virtual]

Reimplemented from TDF_Attribute.

virtual Standard_Boolean TObj_TReference::BeforeUndo	(	const Handle< TDF_AttributeDelta > &	theDelta,
		const Standard_Boolean	isForced = Standard_False
	)		[virtual]

Reimplemented from TDF_Attribute.

Handle< TObj_Object > TObj_TReference::Get

(

)

const

static const Standard_GUID& TObj_TReference::GetID

(

)

[static]

TDF_Label TObj_TReference::GetLabel

(

)

const [inline]

TDF_Label TObj_TReference::GetMasterLabel

(

)

const [inline]

const Standard_GUID& TObj_TReference::ID

(

)

const [virtual]

Implements TDF_Attribute.

Handle< TDF_Attribute > TObj_TReference::NewEmpty

(

)

const [virtual]

Returns an new empty TObj_TReference attribute. It is used by the copy algorithm.

Implements TDF_Attribute.

void TObj_TReference::Paste	(	const Handle< TDF_Attribute > &	theInto,
		const Handle< TDF_RelocationTable > &	theRT
	)		const [virtual]

Implements TDF_Attribute.

void TObj_TReference::Restore

(

const Handle< TDF_Attribute > &

theWith

)

[virtual]

Implements TDF_Attribute.

void TObj_TReference::Set	(	const Handle< TObj_Object > &	theObject,
		const TDF_Label &	theMasterLabel
	)

Sets the reference to the theObject

void TObj_TReference::Set	(	const TDF_Label &	theLabel,
		const TDF_Label &	theMasterLabel
	)

static Handle< TObj_TReference > TObj_TReference::Set	(	const TDF_Label &	theLabel,
		const Handle< TObj_Object > &	theObject,
		const Handle< TObj_Object > &	theMaster
	)		[static]

Creates reference on TDF_Label <theLabel> to the object <theObject> and creates backreference from the object <theObject> to <theMaster> one.

---

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

• TObj_TReference.hxx