R3DImportProgress Class Reference

#include <R3D/Common/R3DImportProgress.h>

Inherits IR3DProgress.

Inheritance diagram for R3DImportProgress:

Inheritance graph
[legend]
Collaboration diagram for R3DImportProgress:

Collaboration graph
[legend]
List of all members.

Detailed Description

Concrete implementation for the IR3DImportProgress class.

Author:
Michael A. Jackson for BlueQuartz Software
Date:
Mar 19, 2009
Version:
1.0


Public Member Functions

void setMessage (const std::string &message)
 Sets the a message to be displayed or otherwise shown to the user.
void setProgress (float progress)
 sets the amount of import completed
void cancelProcess ()
 Sets a flag that the process should stop running.
bool isCancelled ()
 Is the import cancelled.
void finished ()
 Is the thread or process that this IR3DProgress object is attached to finished.


Member Function Documentation

void R3DImportProgress::setMessage ( const std::string &  message  )  [virtual]

Sets the a message to be displayed or otherwise shown to the user.

Parameters:
message The message to be displayed

Implements IR3DProgress.

void R3DImportProgress::setProgress ( float  progress  )  [virtual]

sets the amount of import completed

Parameters:
progress Floating point number that should fall between 0.0 and 1.0 to be used as a percentage

Implements IR3DProgress.

bool R3DImportProgress::isCancelled (  )  [virtual]

Is the import cancelled.

Returns:

Implements IR3DProgress.


The documentation for this class was generated from the following files:
Generated on Fri Aug 28 14:04:33 2009 for R3DImageTools by  doxygen 1.5.2