IControlObject Class Reference

Interface for retrieving status and progress information from a module run. More...

#include "IControlObject.hpp"

Public Member Functions
virtual void	setStages (const Vector< String > &stageDescriptions)=0
	sets the descriptions of the stages (implicitly sets the number of stages. it will be set within the module's run function)
virtual void	setCurrStage (unsigned currentStage)=0
	sets the current stage (zero based index) In rare situations no step information will be available for a certain stage. Usually those stages are processed quite quickly
virtual void	setSteps (long long stepCount)=0
	sets the number of steps for the current stage (will be called after the stage was set) This function is always called before the first corresponding setCurrStep call.
virtual void	setCurrStep (long long currStep)=0
	sets the current step It is internally secured that for the last setCurrStep call currStep >= stepCount for the corresponding stage.
virtual void	log (LogLevel level, unsigned threadId, const char *message)=0
	retrieve log message

Detailed Description

Interface for retrieving status and progress information from a module run.

Author

jo

Date

06.09.2012