Main Page | Modules | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members | Related Pages
regina::NProgressMessage

regina::NProgressMessage Class Reference
[Progress Management]

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

#include <nprogresstypes.h>

Inheritance diagram for regina::NProgressMessage:

regina::NProgress regina::ShareableObject regina::NMutex regina::boost::noncopyable 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.

Protected Member Functions

virtual std::string internalGetDescription () const
 Returns a string description of the current state of progress.

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 [inline, protected, virtual]
 

Returns a string description of the current state of progress.

Returns:
the current state of progress.

Implements regina::NProgress.

void regina::NProgressMessage::setMessage (  const char *  newMessage  )  [inline]
 

Sets the current progress message to the given string.

Parameters:
newMessage the new state of progress.

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.

The documentation for this class was generated from the following file:
Copyright © 1999-2004, Ben Burton
This software is released under the GNU General Public License.
For further information, or to submit a bug or other problem, please contact Ben Burton (bab@debian.org).