regina::NProgressMessage Class Reference

A progress report in which the current state of progress is stored as a string message. More...

#include <progress/nprogresstypes.h>

Inheritance diagram for regina::NProgressMessage:

List of all members.

Public Member Functions
	NProgressMessage ()
	Creates a new progress report with an empty progress message.
	NProgressMessage (const std::string &newMessage)
	Creates a new progress report with the given progress message.
	NProgressMessage (const char *newMessage)
	Creates a new progress report with the given progress message.
std::string	getMessage () const
	Returns a reference to the current progress message.
void	setMessage (const std::string &newMessage)
	Sets the current progress message to the given string.
void	setMessage (const char *newMessage)
	Sets the current progress message to the given string.
Public Member Functions inherited from regina::NProgress
	NProgress ()
	Performs basic initialisation.
virtual	~NProgress ()
	Destroys this object.
bool	hasChanged () const
	Determines if the state of progress has changed since the last query.
bool	isFinished () const
	Is the operation whose progress we are reporting completely finished?
void	setFinished ()
	Signifies that the operation whose progress we are reporting is completely finished.
void	cancel () const
	Called by an external interface to request that the operation whose progress we are reporting be cancelled.
bool	isCancelled () const
	Determines whether an external interface has requested that the operation whose progress we are reporting be cancelled.
std::string	getDescription () const
	Returns a string description of the current state of progress.
virtual bool	isPercent () const
	Determines if the state of progress can be expressed as a percentage.
double	getPercent () const
	Returns the current state of progress as a percentage.
long	getRealTime () const
	Returns the real time elapsed since this operation began.
long	totalCPUTime () const
	Returns the total CPU time consumed by the program from the beginning to the end of this operation.
void	writeTextShort (std::ostream &out) const
	Writes this object in short text format to the given output stream.
Public Member Functions inherited from regina::ShareableObject
	ShareableObject ()
	Default constructor that does nothing.
virtual	~ShareableObject ()
	Default destructor that does nothing.
virtual void	writeTextLong (std::ostream &out) const
	Writes this object in long text format to the given output stream.
std::string	toString () const
	Returns the output from writeTextShort() as a string.
std::string	toStringLong () const
	Returns the output from writeTextLong() as a string.

Protected Member Functions
virtual std::string	internalGetDescription () const
	Returns a string description of the current state of progress.
Protected Member Functions inherited from regina::NProgress
virtual double	internalGetPercent () const
	Returns the current state of progress as a percentage.
Protected Member Functions inherited from regina::NMutex
	NMutex ()
	Creates a new mutex.
	~NMutex ()
	Destroys this mutex.

Additional Inherited Members
Protected Attributes inherited from regina::NProgress
bool	changed
	Has the state of progress changed since the last query?

---

Detailed Description

A progress report in which the current state of progress is stored as a string message.

Python:

Not present; all progress classes communicate with external interfaces through the NProgress interface.

---

Constructor & Destructor Documentation

regina::NProgressMessage::NProgressMessage ( )

inline

Creates a new progress report with an empty progress message.

Note that the internal mutex is not locked during construction.

regina::NProgressMessage::NProgressMessage ( const std::string &  newMessage )

inline

Creates a new progress report with the given progress message.

Note that the internal mutex is not locked during construction.

Parameters:

newMessage

the current state of progress.

regina::NProgressMessage::NProgressMessage ( const char *  newMessage )

inline

Creates a new progress report with the given progress message.

Note that the internal mutex is not locked during construction.

Parameters:

newMessage

the current state of progress.

---

Member Function Documentation

std::string regina::NProgressMessage::getMessage ( ) const

inline

Returns a reference to the current progress message.

Returns:

the current progress message.

std::string regina::NProgressMessage::internalGetDescription ( ) const

inlineprotectedvirtual

Returns a string description of the current state of progress.

Returns:

the current state of progress.

Implements regina::NProgress.

void regina::NProgressMessage::setMessage ( const std::string &  newMessage )

inline

Sets the current progress message to the given string.

Parameters:

newMessage

the new state of progress.

void regina::NProgressMessage::setMessage ( const char *  newMessage )

inline

Sets the current progress message to the given string.

Parameters:

newMessage

the new state of progress.

---

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

• progress/nprogresstypes.h