Model Railroad System  2.2.1
Public Member Functions | List of all members
FCFSupport::WorkInProgressCallback Class Reference

Work In Progress Callback. More...

#include <CallBack.h>

Public Member Functions

 WorkInProgressCallback ()
 Constructor. More...
 
virtual ~WorkInProgressCallback ()
 Destructor. More...
 
virtual void ProgressStart (const string Message) const
 Start up the work in progress display. More...
 
virtual void ProgressUpdate (int Percent, const string Message) const
 Update the progress meter. More...
 
virtual void ProgressDone (const string Message) const
 Mark the process meter as done. More...
 

Detailed Description

Work In Progress Callback.

Provides a callback to manage a work in progress display. This class is a dummy base class. Applications can define member functions that manage an application specific work in progress display.

Author
Robert Heller <heller@deepsoft.com>

Constructor & Destructor Documentation

◆ WorkInProgressCallback()

FCFSupport::WorkInProgressCallback::WorkInProgressCallback ( )
inline

Constructor.

The base constructor does nothing. It is presumed that a derived class might do something useful.

◆ ~WorkInProgressCallback()

virtual FCFSupport::WorkInProgressCallback::~WorkInProgressCallback ( )
inlinevirtual

Destructor.

The base destructor does nothing. It is presumed that a derived class might do something useful.

Member Function Documentation

◆ ProgressDone()

virtual void FCFSupport::WorkInProgressCallback::ProgressDone ( const string  Message) const
inlinevirtual

Mark the process meter as done.

Forces the meter to 100 percent and display a work completion message.

Parameters
MessageA message to display.

◆ ProgressStart()

virtual void FCFSupport::WorkInProgressCallback::ProgressStart ( const string  Message) const
inlinevirtual

Start up the work in progress display.

An initial message is passed to be displayed.

Parameters
MessageAn initial message string.

◆ ProgressUpdate()

virtual void FCFSupport::WorkInProgressCallback::ProgressUpdate ( int  Percent,
const string  Message 
) const
inlinevirtual

Update the progress meter.

Advance the progress meter to the percent completed and display an updated message describing the progress.

Parameters
PercentThe completion percentage, between 0 and 100. A value of 100 indicates that the job is done.
MessageA message to display, typically something identifing what tasks have been completed.