A status monitoring callback that sends progress information to the process console. More...
#include <StandardStatus.h>
Inheritance diagram for pcl::StandardStatus:
Public Member Functions | |
| StandardStatus ()=default | |
| StandardStatus (const StandardStatus &x) | |
| StandardStatus (StandardStatus &&x) | |
| ~StandardStatus () override | |
| int | Completed (const StatusMonitor &monitor) const override |
| void | InfoUpdated (const StatusMonitor &monitor) const override |
| int | Initialized (const StatusMonitor &monitor) const override |
| StandardStatus & | operator= (const StandardStatus &x) |
| StandardStatus & | operator= (StandardStatus &&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 () |
| StatusCallback & | operator= (const StatusCallback &)=default |
| StatusCallback & | operator= (StatusCallback &&)=default |
Detailed Description
StandardStatus uses the processing console associated with the current processing thread to provide feedback and progress information on a process being monitored by a StatusMonitor object.
StandardStatus is suitable for processes where a total status monitoring count can be computed in advance. For example, this happens with processes that operate on a pixel-by-pixel basis and perform a fixed number of iterations, or a number of iterations that can be predicted before running the process. For cases where a total count is not available or cannot be computed, the SpinStatus class is more suitable.
StandardStatus and SpinStatus are used by all standard PixInsight processes and file formats. Unless a specific module has an extremely good reason to proceed otherwise, we recommend that all modules also use these monitoring classes. This ensures that efficient and coherent feedback is provided to the user on the entire PixInsight platform.
In addition, using StandardStatus (and also SpinStatus) allows the PixInsight core application to process mouse, keyboard and screen update events. In this way the application's GUI can be responsive if the user requests aborting or suspending the monitored process.
- See also
- StatusCallback, StatusMonitor, Console, SpinStatus, ProgressBarStatus, MuteStatus
Definition at line 99 of file StandardStatus.h.
Constructor & Destructor Documentation
◆ StandardStatus() [1/3]
|
default |
Constructs a default StandardStatus object.
◆ StandardStatus() [2/3]
|
inline |
Copy constructor.
Definition at line 111 of file StandardStatus.h.
◆ StandardStatus() [3/3]
|
inline |
Move constructor.
Definition at line 120 of file StandardStatus.h.
◆ ~StandardStatus()
|
inlineoverride |
Destroys a StandardStatus instance.
Definition at line 132 of file StandardStatus.h.
Member Function Documentation
◆ Completed()
|
overridevirtual |
Function called by a status monitor object to signal that the current process has finished.
Implements pcl::StatusCallback.
◆ InfoUpdated()
|
overridevirtual |
Function called by a status monitor object when the progress information for the current process has been changed.
Implements pcl::StatusCallback.
◆ Initialized()
|
overridevirtual |
This function is called by a status monitor object when a new monitored process is about to start.
Implements pcl::StatusCallback.
◆ operator=() [1/2]
|
inline |
Copy constructor. Returns a reference to this object.
Definition at line 139 of file StandardStatus.h.
◆ operator=() [2/2]
|
inline |
Move constructor. Returns a reference to this object.
Definition at line 149 of file StandardStatus.h.
◆ Updated()
|
overridevirtual |
Function called by a status monitor object to signal an update of the progress count for the current process.
Implements pcl::StatusCallback.
The documentation for this class was generated from the following file:
