PCL
pcl::MuteStatus Class Reference

A status monitoring callback that does not provide any progress information. More...

#include <MuteStatus.h>

+ Inheritance diagram for pcl::MuteStatus:

Public Member Functions

 MuteStatus ()=default
 
 MuteStatus (const MuteStatus &x)
 
 MuteStatus (MuteStatus &&x)
 
 ~MuteStatus () override
 
int Completed (const StatusMonitor &monitor) const override
 
void InfoUpdated (const StatusMonitor &monitor) const override
 
int Initialized (const StatusMonitor &monitor) const override
 
MuteStatusoperator= (const MuteStatus &x)
 
MuteStatusoperator= (MuteStatus &&x)
 
int Updated (const StatusMonitor &monitor) const override
 
- Public Member Functions inherited from pcl::StatusCallback
 StatusCallback ()=default
 
 StatusCallback (const StatusCallback &)=default
 
 StatusCallback (StatusCallback &&)=default
 
virtual ~StatusCallback ()
 
StatusCallbackoperator= (const StatusCallback &)=default
 
StatusCallbackoperator= (StatusCallback &&)=default
 

Detailed Description

MuteStatus does not provide any information on the ongoing monitored process. However, it does check if either the current thread has been aborted (when the status monitoring process has been initiated from a running Thread object), or if the user has requested to cancel the current process (when the process has been initiated from the main thread). In both cases MuteStatus attempts to terminate the process being monitored.

MuteStatus is useful as a specialized monitoring callback for processes running in threads, or for fast processes that don't require providing detailed progress information to the user. Compared to other callback objects such as StandardStatus and SpinStatus, MuteStatus saves the tasks of generating textual information and writing it to GUI controls. These auxiliary tasks can be expensive for fast processes, and in some cases they may require even more computing time than the processes themselves.

See also
StatusCallback, StatusMonitor, StandardStatus, SpinStatus, ProgressBarStatus, RealTimeProgressStatus, Console

Definition at line 92 of file MuteStatus.h.

Constructor & Destructor Documentation

◆ MuteStatus() [1/3]

pcl::MuteStatus::MuteStatus ( )
default

Constructs a default MuteStatus object.

◆ MuteStatus() [2/3]

pcl::MuteStatus::MuteStatus ( const MuteStatus x)
inline

Copy constructor.

Definition at line 104 of file MuteStatus.h.

◆ MuteStatus() [3/3]

pcl::MuteStatus::MuteStatus ( MuteStatus &&  x)
inline

Move constructor.

Definition at line 112 of file MuteStatus.h.

◆ ~MuteStatus()

pcl::MuteStatus::~MuteStatus ( )
inlineoverride

Destroys a MuteStatus instance.

Definition at line 123 of file MuteStatus.h.

Member Function Documentation

◆ Completed()

int pcl::MuteStatus::Completed ( const StatusMonitor monitor) const
overridevirtual

Function called by a status monitor object to signal that the current process has finished.

Implements pcl::StatusCallback.

Reimplemented in pcl::RealTimeProgressStatus.

Referenced by pcl::RealTimeProgressStatus::Completed().

◆ InfoUpdated()

void pcl::MuteStatus::InfoUpdated ( const StatusMonitor monitor) const
overridevirtual

Function called by a status monitor object when the progress information for the current process has been changed.

Implements pcl::StatusCallback.

Reimplemented in pcl::RealTimeProgressStatus.

◆ Initialized()

int pcl::MuteStatus::Initialized ( const StatusMonitor monitor) const
overridevirtual

This function is called by a status monitor object when a new monitored process is about to start.

Implements pcl::StatusCallback.

Reimplemented in pcl::RealTimeProgressStatus.

Referenced by pcl::RealTimeProgressStatus::Initialized().

◆ operator=() [1/2]

MuteStatus& pcl::MuteStatus::operator= ( const MuteStatus x)
inline

Copy assignment operator. Returns a reference to this object.

Definition at line 130 of file MuteStatus.h.

◆ operator=() [2/2]

MuteStatus& pcl::MuteStatus::operator= ( MuteStatus &&  x)
inline

Move assignment operator. Returns a reference to this object.

Definition at line 138 of file MuteStatus.h.

◆ Updated()

int pcl::MuteStatus::Updated ( const StatusMonitor monitor) const
overridevirtual

Function called by a status monitor object to signal an update of the progress count for the current process.

Implements pcl::StatusCallback.

Reimplemented in pcl::RealTimeProgressStatus.

Referenced by pcl::RealTimeProgressStatus::Updated().


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