Medical Imaging Interaction Toolkit  2022.04.99-e36380da
Medical Imaging Interaction Toolkit
berry::IProgressMonitor Struct Referenceabstract

#include <berryIProgressMonitor.h>

Inheritance diagram for berry::IProgressMonitor:
Collaboration diagram for berry::IProgressMonitor:

Public Member Functions

 berryObjectMacro (berry::IProgressMonitor)
 
virtual void BeginTask (const std::string &name, int totalWork)=0
 
virtual void Done ()=0
 
virtual void InternalWorked (double work)=0
 
virtual bool IsCanceled ()=0
 
virtual void SetCanceled (bool value)=0
 
virtual void SetTaskName (const std::string &name)=0
 
virtual void SubTask (const std::string &name)=0
 
virtual void Worked (int work)=0
 
- Public Member Functions inherited from berry::Object
virtual QString GetClassName () const
 
virtual Reflection::TypeInfo GetTypeInfo () const
 
virtual QList< Reflection::TypeInfoGetSuperclasses () const
 
virtual void Delete ()
 
QDebug Print (QDebug os, Indent Indent=0) const
 
virtual QString ToString () const
 
virtual uint HashCode () const
 
virtual bool operator< (const Object *) const
 
void Register () const
 
void UnRegister (bool del=true) const
 
int GetReferenceCount () const
 
void SetReferenceCount (int)
 
void AddDestroyListener (const MessageAbstractDelegate<> &delegate) const
 
void RemoveDestroyListener (const MessageAbstractDelegate<> &delegate) const
 
virtual bool operator== (const Object *) const
 

Static Public Attributes

static const int UNKNOWN
 

Additional Inherited Members

- Public Types inherited from berry::Object
typedef Object Self
 
typedef berry::SmartPointer< SelfPointer
 
typedef berry::SmartPointer< const SelfConstPointer
 
typedef berry::WeakPointer< SelfWeakPtr
 
typedef berry::WeakPointer< const SelfConstWeakPtr
 
- Static Public Member Functions inherited from berry::Object
static const char * GetStaticClassName ()
 
static Reflection::TypeInfo GetStaticTypeInfo ()
 
static QList< Reflection::TypeInfoGetStaticSuperclasses ()
 
- Protected Member Functions inherited from berry::Object
 Object ()
 
virtual ~Object ()
 
virtual QDebug PrintSelf (QDebug os, Indent indent) const
 
virtual QDebug PrintHeader (QDebug os, Indent indent) const
 
virtual QDebug PrintTrailer (QDebug os, Indent indent) const
 
- Protected Attributes inherited from berry::Object
QAtomicInt m_ReferenceCount
 
QMutex m_ReferenceCountLock
 

Detailed Description

Definition at line 23 of file berryIProgressMonitor.h.

Member Function Documentation

◆ BeginTask()

virtual void berry::IProgressMonitor::BeginTask ( const std::string &  name,
int  totalWork 
)
pure virtual

Notifies that the main task is beginning. This must only be called once on a given progress monitor instance.

Parameters
namethe name (or description) of the main task
totalWorkthe total number of work units into which the main task is been subdivided. If the value is UNKNOWN the implementation is free to indicate progress in a way which doesn't require the total number of work units in advance.

Implemented in berry::NullProgressMonitor.

◆ berryObjectMacro()

berry::IProgressMonitor::berryObjectMacro ( berry::IProgressMonitor  )

◆ Done()

virtual void berry::IProgressMonitor::Done ( )
pure virtual

Notifies that the work is done; that is, either the main task is completed or the user canceled it. This method may be called more than once (implementations should be prepared to handle this case).

Implemented in berry::NullProgressMonitor.

◆ InternalWorked()

virtual void berry::IProgressMonitor::InternalWorked ( double  work)
pure virtual

Internal method to handle scaling correctly. This method must not be called by a client. Clients should always use the method worked(int).

Parameters
workthe amount of work done

Implemented in berry::NullProgressMonitor.

◆ IsCanceled()

virtual bool berry::IProgressMonitor::IsCanceled ( )
pure virtual

Returns whether cancellation of current operation has been requested. Long-running operations should poll to see if cancellation has been requested.

Returns
true if cancellation has been requested, and false otherwise
See also
SetCanceled

Implemented in berry::NullProgressMonitor.

◆ SetCanceled()

virtual void berry::IProgressMonitor::SetCanceled ( bool  value)
pure virtual

Sets the cancel state to the given value.

Parameters
valuetrue indicates that cancellation has been requested (but not necessarily acknowledged); false clears this flag
See also
IsCanceled

Implemented in berry::NullProgressMonitor.

◆ SetTaskName()

virtual void berry::IProgressMonitor::SetTaskName ( const std::string &  name)
pure virtual

Sets the task name to the given value. This method is used to restore the task label after a nested operation was executed. Normally there is no need for clients to call this method.

Parameters
namethe name (or description) of the main task
See also
BeginTask

Implemented in berry::NullProgressMonitor.

◆ SubTask()

virtual void berry::IProgressMonitor::SubTask ( const std::string &  name)
pure virtual

Notifies that a subtask of the main task is beginning. Subtasks are optional; the main task might not have subtasks.

Parameters
namethe name (or description) of the subtask

Implemented in berry::NullProgressMonitor.

◆ Worked()

virtual void berry::IProgressMonitor::Worked ( int  work)
pure virtual

Notifies that a given number of work unit of the main task has been completed. Note that this amount represents an installment, as opposed to a cumulative amount of work done to date.

Parameters
worka non-negative number of work units just completed

Implemented in berry::NullProgressMonitor.

Member Data Documentation

◆ UNKNOWN

const int berry::IProgressMonitor::UNKNOWN
static

Constant indicating an unknown amount of work.

Definition at line 30 of file berryIProgressMonitor.h.


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