DtVrfCallbackQueue::CallbackInterface Class Reference

API for writing callbacks.

Inheritance diagram for DtVrfCallbackQueue::CallbackInterface:

Classes
class	RefWrapper
class	Wrapper

Public Types
typedef boost::shared_ptr < CallbackInterface >	Ptr

Public Member Functions
virtual	~CallbackInterface ()
virtual std::string	label () const
virtual void	run ()=0
virtual void	cancel ()
virtual bool	valid () const

Member Typedef Documentation

typedef boost::shared_ptr<CallbackInterface> DtVrfCallbackQueue::CallbackInterface::Ptr

Constructor & Destructor Documentation

virtual DtVrfCallbackQueue::CallbackInterface::~CallbackInterface ( )

virtual

Virtual destructor.

Member Function Documentation

virtual std::string DtVrfCallbackQueue::CallbackInterface::label ( ) const

virtual

Name of callback, used only for logging and debugging.

Reimplemented in DtVrfCallbackQueue::CallbackInterface::RefWrapper, and DtVrfCallbackQueue::CallbackInterface::Wrapper.

Referenced by DtVrfCallbackQueue::CallbackInterface::Wrapper::label(), and DtVrfCallbackQueue::CallbackInterface::RefWrapper::label().

virtual void DtVrfCallbackQueue::CallbackInterface::run ( )

pure virtual

Run callback.

Implemented in DtLocalObject::SimObjectCallback, DtVrfCallbackQueue::CallbackInterface::RefWrapper, DtVrfCallbackQueue::CallbackInterface::Wrapper, DtSnapshotManager::DtWriteSnapshotJob, and makVrf::DtSimObjectNetInterface::ParallelContainer.

Referenced by DtVrfCallbackQueue::CallbackInterface::Wrapper::run(), and DtVrfCallbackQueue::CallbackInterface::RefWrapper::run().

virtual void DtVrfCallbackQueue::CallbackInterface::cancel ( )

virtual

Will be called if the callback will not be run before it's discarded.

Reimplemented in DtVrfCallbackQueue::CallbackInterface::RefWrapper, and DtVrfCallbackQueue::CallbackInterface::Wrapper.

Referenced by DtVrfCallbackQueue::CallbackInterface::Wrapper::cancel(), and DtVrfCallbackQueue::CallbackInterface::RefWrapper::cancel().

virtual bool DtVrfCallbackQueue::CallbackInterface::valid ( ) const

virtual

Returns false the callback has become null.

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-1-branch/include/vrfutil/vrfCallbackQueue.h