VizKit  3.3.7
Public Member Functions | Static Public Attributes | Private Member Functions | Private Attributes
VizKit::VisualProgressIndicator Class Reference

A VisualProgressIndicator communicates the progress of a process. More...

#include <VisualProgressIndicator.h>

List of all members.

Public Member Functions

 VisualProgressIndicator ()
 The constructor.
 ~VisualProgressIndicator ()
 The destructor.
 VisualProgressIndicator (const VisualProgressIndicator &other)
 Copy constructor.
VisualProgressIndicatoroperator= (const VisualProgressIndicator &other)
 Assignment operator.
double getState (void) const
 Returns the current state of the progress indicator.
void setState (double state)
 Sets the state of the progress indicator.

Static Public Attributes

static const double kProgressNotStarted = -1.0
 Progress did not start yet.
static const double kProgressUnknown = -2.0
 Progress is not known (possibly because the complete amount of data is not known).

Private Member Functions

void copy (const VisualProgressIndicator &other)
 Copy method for assignment operator and copy constructor.

Private Attributes

double currentProgressState
 The current state of the progress.

Detailed Description

A VisualProgressIndicator communicates the progress of a process.

Basically the indicator goes from 0.0 to 1.0.


Constructor & Destructor Documentation

The constructor.

The destructor.

Copy constructor.

Parameters:
otherReference to another VisualProgressIndicator.

Member Function Documentation

void VisualProgressIndicator::copy ( const VisualProgressIndicator other) [private]

Copy method for assignment operator and copy constructor.

Parameters:
otherAnother VisualProgressIndicator.
double VisualProgressIndicator::getState ( void  ) const

Returns the current state of the progress indicator.

Returns:
The current state of the progress indicator.
VisualProgressIndicator & VisualProgressIndicator::operator= ( const VisualProgressIndicator other)

Assignment operator.

Parameters:
otherReference to another VisualProgressIndicator.
void VisualProgressIndicator::setState ( double  state)

Sets the state of the progress indicator.

Parameters:
stateThe state of the progress indicator.

Member Data Documentation

The current state of the progress.

const double VisualProgressIndicator::kProgressNotStarted = -1.0 [static]

Progress did not start yet.

const double VisualProgressIndicator::kProgressUnknown = -2.0 [static]

Progress is not known (possibly because the complete amount of data is not known).


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

Generated on Sun May 3 2015 20:26:31 for VizKit by doxygen 1.8.0