HDK_Sample::BackgroundTimer Class Reference

Event generator to poll for completed tasks. More...

Inheritance diagram for HDK_Sample::BackgroundTimer:

List of all members.

Public Member Functions
	BackgroundTimer ()
virtual	~BackgroundTimer ()
virtual const char *	getClassName () const
virtual int	getPollTime ()
	Poll time is in ms, so poll every 0.5 seconds.
virtual int	processEvents ()
	This callback is used to process events.
Static Public Member Functions
static void	stopPolling ()
	Stop polling process.
static void	startPolling ()
	Start polling process.

---

Detailed Description

Event generator to poll for completed tasks.

When Houdini has an opportunity, it will call this class to process any events. Ideally, we would use the FS_EventGenerator::getFileDescriptor() method to return a file descriptor which allows a select() call to be used rather than a polling process. However, in this case, we need to poll the background processes.

Definition at line 151 of file FS_Background.C.

---

Constructor & Destructor Documentation

HDK_Sample::BackgroundTimer::BackgroundTimer

(

)

[inline]

Examples:

FS/FS_Background.C.

Definition at line 153 of file FS_Background.C.

virtual HDK_Sample::BackgroundTimer::~BackgroundTimer

(

)

[inline, virtual]

Examples:

FS/FS_Background.C.

Definition at line 154 of file FS_Background.C.

---

Member Function Documentation

virtual const char* HDK_Sample::BackgroundTimer::getClassName

(

)

const [inline, virtual]

Implements FS_EventGenerator.

Examples:

FS/FS_Background.C.

Definition at line 156 of file FS_Background.C.

virtual int HDK_Sample::BackgroundTimer::getPollTime

(

)

[inline, virtual]

Poll time is in ms, so poll every 0.5 seconds.

Reimplemented from FS_EventGenerator.

Examples:

FS/FS_Background.C.

Definition at line 159 of file FS_Background.C.

virtual int HDK_Sample::BackgroundTimer::processEvents

(

)

[inline, virtual]

This callback is used to process events.

Implements FS_EventGenerator.

Examples:

FS/FS_Background.C.

Definition at line 162 of file FS_Background.C.

static void HDK_Sample::BackgroundTimer::startPolling

(

)

[inline, static]

Start polling process.

Examples:

FS/FS_Background.C.

Definition at line 188 of file FS_Background.C.

static void HDK_Sample::BackgroundTimer::stopPolling

(

)

[inline, static]

Stop polling process.

Examples:

FS/FS_Background.C.

Definition at line 173 of file FS_Background.C.

---

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

• samples/FS/FS_Background.C