OdTfObjectReactor Class Reference

#include <TfObjectReactor.h>

Inheritance diagram for OdTfObjectReactor:

Public Member Functions
virtual void	copied (const OdTfObject *pElement, const OdTfObject *pNewElement)=0
virtual void	erased (const OdTfObject *pElement, bool erasing=true)=0
virtual void	goodbye (const OdTfObject *pElement)=0
virtual void	openedForModify (const OdTfObject *pElement)=0
virtual void	modified (const OdTfObject *pElement)=0
virtual void	modifiedGraphics (const OdTfObject *pElement)=0
virtual void	modifiedLinkages (const OdTfObject *pElement)=0
virtual void	subElementModified (const OdTfObject *pElement, const OdTfObject *pSubElm)=0
virtual void	modifyUndone (const OdTfObject *pElement)=0
virtual void	unappended (const OdTfObject *pElement)=0
virtual void	reappended (const OdTfObject *pElement)=0
virtual void	closed (OdDbStub *elementId)=0
Public Member Functions inherited from OdRxObject
	ODRX_HEAP_OPERATORS ()
	OdRxObject ()
virtual	~OdRxObject ()
virtual OdRxObject *	queryX (const OdRxClass *pClass) const
virtual OdRxObject *	x (const OdRxClass *pClass) const
virtual OdRxClass *	isA () const
virtual void	addRef ()=0
virtual void	release ()=0
virtual long	numRefs () const
bool	isKindOf (const OdRxClass *pClass) const
virtual OdRxObjectPtr	clone () const
virtual void	copyFrom (const OdRxObject *pSource)
virtual OdRx::Ordering	comparedTo (const OdRxObject *pOther) const
virtual bool	isEqualTo (const OdRxObject *pOther) const

Additional Inherited Members
Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr	cast (const OdRxObject *pointer)
static OdRxClass *	desc ()

Detailed Description

This class is the base class for custom classes that receive different event notifications from an OdTfObject class instance.

Remarks

The default implementations of all methods in this class do nothing but return.

Corresponding C++ library: Od_Tf

<group OdTf_Classes>

Definition at line 45 of file TfObjectReactor.h.

Member Function Documentation

closed()

virtual void OdTfObjectReactor::closed ( OdDbStub *  elementId )

pure virtual

Notification function called immediately before the element is closed.

Parameters

elementId

[in] An identifier of the element that is being closed.

Remarks

The default implementation of this function does nothing. This function can be overridden in custom classes.

copied()

virtual void OdTfObjectReactor::copied ( const OdTfObject *  pElement, const OdTfObject *  pNewElement  )

pure virtual

Notification function called whenever the notifying element has had its clone() member function called.

Parameters

pElement	[in] A pointer to the notifying element.
pNewElement	[in] A pointer to the element resulting from the copy.

Remarks

The default implementation of this function does nothing. This function can be overridden in custom classes.

erased()

virtual void OdTfObjectReactor::erased ( const OdTfObject *  pElement, bool  erasing = true  )

pure virtual

Notification function called whenever an element has been erased or unerased.

Parameters

pElement	[in] A pointer to the element that was erased/unerased.
erasing	[in] An erase flag value. The flag value is equal to true if the element was erased; otherwise it is equal to false.

Remarks

The default implementation of this function does nothing. This function can be overridden in custom classes.

goodbye()

virtual void OdTfObjectReactor::goodbye ( const OdTfObject *  pElement )

pure virtual

Notification function called just before an element is deleted from the memory.

Parameters

pElement

[in] A pointer to the element that is being deleted.

Remarks

The default implementation of this function does nothing. This function can be overridden in custom classes.

modified()

virtual void OdTfObjectReactor::modified ( const OdTfObject *  pElement )

pure virtual

Notification function called whenever an element that was previously opened for modifications (OdDg::kForWrite mode) was successfully modified and now is being closed.

Parameters

pElement

[in] A pointer to the element that is being closed after being modified.

Remarks

The default implementation of this function does nothing. This function can be overridden in custom classes.

modifiedGraphics()

virtual void OdTfObjectReactor::modifiedGraphics ( const OdTfObject *  pElement )

pure virtual

Notification function called whenever an element derived from the OdDgGraphicsElement class is modified.

Parameters

pElement

[in] A pointer to the modified element.

Remarks

The default implementation of this function does nothing. This function can be overridden in custom classes. This function is called whenever one of the following events occurs:

The calling element is opened for modification (OdDg::kForWrite mode).

One of the calling element's member functions:

Calls its assertWriteEnabled() method with the recordModified parameter that is equal to true.

Calls its recordGraphicsModified() method passing to it true as a parameter value.

The calling element is being closed.

This function is called whenever the element is modified. Therefore calling this function indicates that only the graphics for the element is changed.

modifiedLinkages()

virtual void OdTfObjectReactor::modifiedLinkages ( const OdTfObject *  pElement )

pure virtual

Notification function called whenever the attribute linkages have been written to the notifying element.

Parameters

pElement

[in] A pointer to the notifying element.

Remarks

Notification is made upon the pElement->close() method call. The notifying element should be opened for reading (OdDg::kForRead mode). The default implementation of this function does nothing. This function can be overridden in custom classes.

modifyUndone()

virtual void OdTfObjectReactor::modifyUndone ( const OdTfObject *  pElement )

pure virtual

Notification function called whenever the notifying element is in progress of an Undo operation that is undoing modifications.

Parameters

pElement

[in] A pointer to the notifying element.

Remarks

The notifying element should be open for reading (OdDg::kForRead mode). The default implementation of this function does nothing. This function can be overridden in custom classes.

openedForModify()

virtual void OdTfObjectReactor::openedForModify ( const OdTfObject *  pElement )

pure virtual

Notification function called whenever an element is opened for modifications (OdDg::kForWrite mode).

Parameters

pElement

[in] A pointer to the element that is being opened.

Remarks

The default implementation of this function does nothing. This function can be overridden in custom classes.

reappended()

virtual void OdTfObjectReactor::reappended ( const OdTfObject *  pElement )

pure virtual

Notification function called whenever a Redo process re-appends the notifying element to the database.

Parameters

pElement

[in] A pointer to the notifying element.

Remarks

The default implementation of this function does nothing. This function can be overridden in custom classes.

subElementModified()

virtual void OdTfObjectReactor::subElementModified ( const OdTfObject *  pElement, const OdTfObject *  pSubElm  )

pure virtual

Notification function called whenever any method of a specified sub element calls the assertWriteEnabled() method.

Parameters

pElement	[in] A pointer to the notifying element.
pSubElm	[in] A pointer to the sub element that is owned by the element specified with the pElement parameter.

Remarks

Notification is made upon the pElement->close() method call.

unappended()

virtual void OdTfObjectReactor::unappended ( const OdTfObject *  pElement )

pure virtual

Notification function called whenever the Undo process cancels the appending of the notifying element to the database.

Parameters

pElement

[in] A pointer to the notifying element.

Remarks

The notifying element is marked as erased. It is not removed from the database and can be unerased, even before it is created. The default implementation of this function does nothing. This function can be overridden in custom classes.

---

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

• TfObjectReactor.h