qi::ProgressNotifierImpl Class Reference

Inheritance diagram for qi::ProgressNotifierImpl:

Public Member Functions
void	_notifyCanceled () override
void	_notifyFailed () override
void	_notifyFinished () override
void	_notifyProgressed (double newProgress) override
void	_notifyRunning () override
void	_reset () override
bool	isRunning () const override
void	notifyCanceled () override
void	notifyFailed () override
void	notifyFinished () override
void	notifyProgressed (double newProgress) override
void	notifyRunning () override
	ProgressNotifierImpl (Future< void > operationFuture)
void	reset () override
Future< void >	waitForFinished () override
Public Member Functions inherited from qi::ProgressNotifier
	QI_API_DEPRECATED_MSG (Use 'notifyCanceled' instead) virtual void _notifyCanceled()=0
	QI_API_DEPRECATED_MSG (Use 'notifyFailed' instead) virtual void _notifyFailed()=0
	QI_API_DEPRECATED_MSG (Use 'notifyFinished' instead) virtual void _notifyFinished()=0
	QI_API_DEPRECATED_MSG (Use 'notifyProgressed' instead) virtual void _notifyProgressed(double new Progress)=0
	QI_API_DEPRECATED_MSG (Use 'notifyRunning' instead) virtual void _notifyRunning()=0
	QI_API_DEPRECATED_MSG (Use 'reset' instead) virtual void _reset()=0
virtual	~ProgressNotifier ()=default

Public Attributes
Future< void >	_opFuture
Public Attributes inherited from qi::ProgressNotifier
Property< double >	progress
Property< Status >	status

Additional Inherited Members
Public Types inherited from qi::ProgressNotifier
enum	Status {   Status_Idle, Status_Running, Status_Finished, Status_Failed,   Status_Canceled }
Protected Member Functions inherited from qi::ProgressNotifier
	ProgressNotifier ()=default

Detailed Description

Definition at line 14 of file progressnotifier.cpp.

Constructor & Destructor Documentation

ProgressNotifierImpl()

qi::ProgressNotifierImpl::ProgressNotifierImpl ( Future< void >  operationFuture )

inlineexplicit

Definition at line 18 of file progressnotifier.cpp.

Member Function Documentation

_notifyCanceled()

void qi::ProgressNotifierImpl::_notifyCanceled ( )

inlineoverride

Definition at line 100 of file progressnotifier.cpp.

_notifyFailed()

void qi::ProgressNotifierImpl::_notifyFailed ( )

inlineoverride

Definition at line 105 of file progressnotifier.cpp.

_notifyFinished()

void qi::ProgressNotifierImpl::_notifyFinished ( )

inlineoverride

Definition at line 95 of file progressnotifier.cpp.

_notifyProgressed()

void qi::ProgressNotifierImpl::_notifyProgressed ( double  newProgress )

inlineoverride

Definition at line 110 of file progressnotifier.cpp.

_notifyRunning()

void qi::ProgressNotifierImpl::_notifyRunning ( )

inlineoverride

Definition at line 90 of file progressnotifier.cpp.

_reset()

void qi::ProgressNotifierImpl::_reset ( )

inlineoverride

Definition at line 85 of file progressnotifier.cpp.

isRunning()

bool qi::ProgressNotifierImpl::isRunning ( ) const

inlineoverridevirtual

Returns

true if the operation associated to this notifier has started and is neither finished nor canceled nor failed yet, false otherwise.

Implements qi::ProgressNotifier.

Definition at line 72 of file progressnotifier.cpp.

notifyCanceled()

void qi::ProgressNotifierImpl::notifyCanceled ( )

inlineoverridevirtual

Notify the observers that the operation has been canceled by the user.

Remarks

This function is reserved to be used by the implementation of the associated operations.

Implements qi::ProgressNotifier.

Definition at line 48 of file progressnotifier.cpp.

notifyFailed()

void qi::ProgressNotifierImpl::notifyFailed ( )

inlineoverridevirtual

Notify the observers that the operation has failed.

Remarks

This function is reserved to be used by the implementation of the associated operations.

Implements qi::ProgressNotifier.

Definition at line 56 of file progressnotifier.cpp.

notifyFinished()

void qi::ProgressNotifierImpl::notifyFinished ( )

inlineoverridevirtual

Notify the observers that the operation has successfully ended.

Remarks

This function is reserved to be used by the implementation of the associated operations.

Implements qi::ProgressNotifier.

Definition at line 39 of file progressnotifier.cpp.

notifyProgressed()

void qi::ProgressNotifierImpl::notifyProgressed ( double  newProgress )

inlineoverridevirtual

Notify the observers that the operation progressed.

Remarks

This function is reserved to be used by the implementation of the associated operations.

Parameters

newProgress

New value representing the total progress of the operation. By default, uses a range from 0.0 (no work has been done yet) to 1.0 (all work is done). The operation implementation is free to use another range if necessary but should clarify the meaning of this value in its documentation.

Implements qi::ProgressNotifier.

Definition at line 64 of file progressnotifier.cpp.

notifyRunning()

void qi::ProgressNotifierImpl::notifyRunning ( )

inlineoverridevirtual

Notify the observers that the operation associated with this notifier is now running.

Remarks

This function is reserved to be used by the implementation of the associated operations.

Implements qi::ProgressNotifier.

Definition at line 30 of file progressnotifier.cpp.

reset()

void qi::ProgressNotifierImpl::reset ( )

inlineoverridevirtual

Reset the status of the algorithm to the idle state with no progress.

Remarks

This function is reserved to be used by the implementation of the associated operations.

Implements qi::ProgressNotifier.

Definition at line 24 of file progressnotifier.cpp.

waitForFinished()

Future<void> qi::ProgressNotifierImpl::waitForFinished ( )

inlineoverridevirtual

Implements qi::ProgressNotifier.

Definition at line 77 of file progressnotifier.cpp.

Member Data Documentation

_opFuture

Future<void> qi::ProgressNotifierImpl::_opFuture

Definition at line 82 of file progressnotifier.cpp.

---

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

• progressnotifier.cpp