makVrv::DtEventLoop Class Reference

The abstract DtEventLoop class.

Inheritance diagram for makVrv::DtEventLoop:

Public Types
typedef void(*	RunFunction )(DtDe &)

Public Member Functions
virtual	~DtEventLoop ()
void	setAlternateRunFunction (RunFunction aFunction)
void	run ()

Static Public Member Functions
static void	runOnce (DtDe &)
static DtEventLoop *	create (DtDe &theIG)

Protected Member Functions
	DtEventLoop (DtDe &de)
void	defaultRun ()

Protected Attributes
DtDe &	myDe
DtTimedSection *	myTimer
RunFunction	myRunnerFunction

Member Typedef Documentation

typedef void(* makVrv::DtEventLoop::RunFunction)(DtDe &)

Public typedefs.

Constructor & Destructor Documentation

virtual makVrv::DtEventLoop::~DtEventLoop ( )

virtual

DTOR.

makVrv::DtEventLoop::DtEventLoop ( DtDe &  de )

protected

The constructor for an abstract class is not public.

Member Function Documentation

static void makVrv::DtEventLoop::runOnce ( DtDe &  )

static

Helper function for creating a event loop an run once. This function allocates an event loop object and calls run on it, then deallocates it.

static DtEventLoop* makVrv::DtEventLoop::create ( DtDe &  theIG )

static

Helper function for create, gets DtEventLoopCreator instance from the de and calls it's create method.

Exceptions

DtCorruptedState

when the DtEventLoopCreator instance is unable to be found.

void makVrv::DtEventLoop::setAlternateRunFunction

(

RunFunction

aFunction

)

Set an alternate run function. Note it is important that the alternate run function provides some mechanism for calling tick() member function on a regular bases. To disable the alternate function simply pass a NULL pointer to use the defaultRun implementation.

void makVrv::DtEventLoop::run

(

)

Run the app. This calls the alternate run function if one is set, or it will call the defaultRun() function.

void makVrv::DtEventLoop::defaultRun ( )

protected

Default implementation of Run. Implementation: while(!timeToStop()) { tick(); }.

Member Data Documentation

DtDe& makVrv::DtEventLoop::myDe

protected

DtTimedSection* makVrv::DtEventLoop::myTimer

protected

RunFunction makVrv::DtEventLoop::myRunnerFunction

protected

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-1-branch/include/vrvCore/DtEventLoop.h