M/c++_api/inc/DM/IControlObject.hpp

#pragma once
 
#include "DM/config.hpp"
#include "DM/Handle.hpp"
#include "DM/ObjectBase.hpp"
 
DM_NAMESPACE_BEGIN
 
/// \brief Control object are used to get status information of extensive processing step and/or to interrupt those processing steps 
class DM_API IControlObject : public ObjectBase
{
public:
  /// creates an control object for the standard output
  static IControlObject* NewStdOut(bool clearAfterFinish = false, int updatePrecision = 0);
  /// creates an control object for the standard output with callbacks 
  static IControlObject* NewStdOut(void *callbackObj, bool (*isInterrupted)(void *), void (*setStepCount)(void *, long long), void (*setCurrStep)(void *, long long), bool clearAfterFinish = false, int updatePrecision = 0);
 
  /// creates an 'silent' control object which doesn't make any output
  static IControlObject* NewSilent();
  /// creates an 'silent' control object which doesn't make any output but with callbacks 
  static IControlObject* NewSilent(void *callbackObj, bool (*isInterrupted)(void *), void (*setStepCount)(void *, long long), void (*setCurrStep)(void *, long long));
 
protected:
  virtual ~IControlObject() {}
 
public:
  virtual IControlObject *clone() const = 0;
 
  /// set overall step count
  virtual void    stepCount( int64_t stepCount ) = 0;
  /// get overall step count
  virtual int64_t stepCount() const = 0;
 
  /// set current step
  virtual void    currentStep( int64_t  currStep ) = 0; 
  /// increase current step 
  virtual void    increaseCurrentStep( int64_t incCount  = 1 ) = 0;
  /// get current step
  virtual int64_t currentStep() const = 0;
  /// returns current step in [%]
  virtual double  currentStepPercentage() const = 0;
 
  /// set the interrupt flag
  virtual void    interrupt( bool flag ) = 0;
  /// returns the interrupt flag
  virtual bool    interrupted() const = 0;
 
  /// set the finished flag
  virtual void    finish( bool flag ) = 0;
  /// returns the finished flag
  virtual bool    finished() const = 0;
};
 
 
typedef Handle< IControlObject > ControlObjectHandle;
 
DM_NAMESPACE_END