Medical Imaging Interaction Toolkit  2023.12.99-101158b3
Medical Imaging Interaction Toolkit
berry::NullProgressMonitor Class Reference

#include <berryNullProgressMonitor.h>

Inheritance diagram for berry::NullProgressMonitor:
Collaboration diagram for berry::NullProgressMonitor:

Public Member Functions

 berryObjectMacro (NullProgressMonitor)
 
 NullProgressMonitor ()
 
void BeginTask (const std::string &name, int totalWork) override
 
void Done () override
 
void InternalWorked (double work) override
 
bool IsCanceled () override
 
void SetCanceled (bool cancelled) override
 
void SetTaskName (const std::string &name) override
 
void SubTask (const std::string &name) override
 
void Worked (int work) override
 
- Public Member Functions inherited from berry::IProgressMonitor
 berryObjectMacro (berry::IProgressMonitor)
 
- 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
 

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 ()
 
- Static Public Attributes inherited from berry::IProgressMonitor
static const int UNKNOWN
 
- 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

A default progress monitor implementation suitable for subclassing.

This implementation supports cancellation. The default implementations of the other methods do nothing.

This class can be used without OSGi running.

Definition at line 32 of file berryNullProgressMonitor.h.

Constructor & Destructor Documentation

◆ NullProgressMonitor()

berry::NullProgressMonitor::NullProgressMonitor ( )

Constructs a new progress monitor.

Member Function Documentation

◆ BeginTask()

void berry::NullProgressMonitor::BeginTask ( const std::string &  name,
int  totalWork 
)
overridevirtual

This implementation does nothing. Subclasses may override this method to do interesting processing when a task begins.

See also
IProgressMonitor::BeginTask(std::string, int)

Implements berry::IProgressMonitor.

◆ berryObjectMacro()

berry::NullProgressMonitor::berryObjectMacro ( NullProgressMonitor  )

◆ Done()

void berry::NullProgressMonitor::Done ( )
overridevirtual

This implementation does nothing. Subclasses may override this method to do interesting processing when a task is done.

See also
IProgressMonitor::Done()

Implements berry::IProgressMonitor.

◆ InternalWorked()

void berry::NullProgressMonitor::InternalWorked ( double  work)
overridevirtual

This implementation does nothing. Subclasses may override this method.

See also
IProgressMonitor::InternalWorked(double)

Implements berry::IProgressMonitor.

◆ IsCanceled()

bool berry::NullProgressMonitor::IsCanceled ( )
overridevirtual

This implementation returns the value of the internal state variable set by setCanceled. Subclasses which override this method should override setCanceled as well.

See also
IProgressMonitor::IsCanceled()
IProgressMonitor::SetCanceled(bool)

Implements berry::IProgressMonitor.

◆ SetCanceled()

void berry::NullProgressMonitor::SetCanceled ( bool  cancelled)
overridevirtual

This implementation sets the value of an internal state variable. Subclasses which override this method should override isCanceled as well.

See also
IProgressMonitor::IsCanceled()
IProgressMonitor::SetCanceled(bool)

Implements berry::IProgressMonitor.

◆ SetTaskName()

void berry::NullProgressMonitor::SetTaskName ( const std::string &  name)
overridevirtual

This implementation does nothing. Subclasses may override this method to do something with the name of the task.

See also
IProgressMonitor::SetTaskName(const std::string&)

Implements berry::IProgressMonitor.

◆ SubTask()

void berry::NullProgressMonitor::SubTask ( const std::string &  name)
overridevirtual

This implementation does nothing. Subclasses may override this method to do interesting processing when a subtask begins.

See also
IProgressMonitor::SubTask(const std::string&)

Implements berry::IProgressMonitor.

◆ Worked()

void berry::NullProgressMonitor::Worked ( int  work)
overridevirtual

This implementation does nothing. Subclasses may override this method to do interesting processing when some work has been completed.

See also
IProgressMonitor::Worked(int)

Implements berry::IProgressMonitor.


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