DDD_ProgressPublisher Class Reference

Base class used by children of processes requesting periodic status updates. More...

#include <DDD_ProgressPublisher.h>

Inheritance diagram for DDD_ProgressPublisher:

Public Member Functions
	DDD_ProgressPublisher ()
void	SetProgressCallback (ProgressCallback callback)
void	UpdateProgress (float percentage)

Protected Attributes
ProgressCallback	_progressCb
float	_currentProgress

Detailed Description

Base class used by children of processes requesting periodic status updates.

Remarks

The percentage value is local; this object should start at 0 and finish at 100. Let the parent worry about the relative progress.

Constructor & Destructor Documentation

DDD_ProgressPublisher

(

)

Constructor

Member Function Documentation

void SetProgressCallback

(

ProgressCallback

callback

)

Set a progress callback for notifying parent processes of our current progress level (0.0-100.0%)

Parameters

callback

The callback that will be called whenever progress is updated

Note

For performance the subscriber may not want to do an action everytime this callback is triggered

void UpdateProgress

(

float

percentage

)

Update the progress value

Parameters

percentage

The new progress value (0-100%)

Member Data Documentation

float _currentProgress

protected

The current progress value

ProgressCallback _progressCb

protected

The progress callback

---

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

• DDD_ProgressPublisher.h