Medical Imaging Interaction Toolkit  2022.10.99-efe2ad43
Medical Imaging Interaction Toolkit
berry::IProgressMonitorWithBlocking Struct Referenceabstract

#include <berryIProgressMonitorWithBlocking.h>

Inheritance diagram for berry::IProgressMonitorWithBlocking:
Collaboration diagram for berry::IProgressMonitorWithBlocking:

Public Member Functions

 berryObjectMacro (berry::IProgressMonitorWithBlocking)
 
virtual void SetBlocked (IStatus::Pointer reason)=0
 
virtual void ClearBlocked ()=0
 
- Public Member Functions inherited from berry::IProgressMonitor
 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
 

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

An extension to the IProgressMonitor interface for monitors that want to support feedback when an activity is blocked due to concurrent activity in another thread.

When a monitor that supports this extension is passed to an operation, the operation should call setBlocked whenever it knows that it must wait for a lock that is currently held by another thread. The operation should continue to check for and respond to cancellation requests while blocked. When the operation is no longer blocked, it must call clearBlocked to clear the blocked state.

This interface can be used without OSGi running.

Clients may implement this interface.

See also
IProgressMonitor

Definition at line 42 of file berryIProgressMonitorWithBlocking.h.

Member Function Documentation

◆ berryObjectMacro()

berry::IProgressMonitorWithBlocking::berryObjectMacro ( berry::IProgressMonitorWithBlocking  )

◆ ClearBlocked()

virtual void berry::IProgressMonitorWithBlocking::ClearBlocked ( )
pure virtual

Clears the blocked state of the running operation. If a running operation ever calls setBlocked, it must eventually call clearBlocked before the operation completes.

See also
SetBlocked

◆ SetBlocked()

virtual void berry::IProgressMonitorWithBlocking::SetBlocked ( IStatus::Pointer  reason)
pure virtual

Indicates that this operation is blocked by some background activity. If a running operation ever calls setBlocked, it must eventually call clearBlocked before the operation completes.

If the caller is blocked by a currently executing job, this method will return an IJobStatus indicating the job that is currently blocking the caller. If this blocking job is not known, this method will return a plain informational IStatus object.

Parameters
reasonan optional status object whose message describes the reason why this operation is blocked, or null if this information is not available.
See also
ClearBlocked

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