ProgressData Class Reference

Class that tracks the progress of scene updates. More...

#include <filter.h>

Collaboration diagram for ProgressData:

Public Member Functions
	ProgressData ()
bool	operator== (const ProgressData &o) const
const ProgressData &	operator= (const ProgressData &o)
void	reset ()
void	clock ()

Public Attributes
unsigned int	filterProgress
	Progress of filter (out of 100, or -1 for no progress information) for current filter. More...
unsigned int	totalProgress
	Number of filters (n) that we have processed (n out of m filters) More...
unsigned int	totalNumFilters
	number of filters which need processing for this update More...
unsigned int	step
	Current step. More...
unsigned int	maxStep
	Maximum steps. More...
const Filter *	curFilter
	Pointer to the current filter that is being updated. More...
std::string	stepName
	Name of current operation, if specified. More...

Detailed Description

Class that tracks the progress of scene updates.

Constructor & Destructor Documentation

ProgressData()

ProgressData::ProgressData

(

)

Member Function Documentation

clock()

void ProgressData::clock ( )

inline

Referenced by FilterTree::refreshFilterTree().

Here is the caller graph for this function:

operator=()

const ProgressData & ProgressData::operator=

(

const ProgressData &

o

)

References ASSERT, curFilter, FilterProperty::data, FILTER_TYPE_ENUM_END, filterProgress, FilterPropGroup::getNthProp(), Filter::getProperties(), FilterPropGroup::getPropValue(), FilterProperty::helpText, FilterProperty::key, makeFilter(), maxStep, FilterPropGroup::numProps(), PROPERTY_TYPE_BOOL, Filter::setProperty(), step, stepName, TEST, totalNumFilters, totalProgress, and FilterProperty::type.

operator==()

bool ProgressData::operator==

(

const ProgressData &

o

)

const

References curFilter, filterProgress, maxStep, step, stepName, totalNumFilters, and totalProgress.

reset()

void ProgressData::reset ( )

inline

Referenced by MainWindowFrame::MainWindowFrame(), and TreeState::refresh().

Here is the caller graph for this function:

Member Data Documentation

curFilter

const Filter* ProgressData::curFilter

Pointer to the current filter that is being updated.

Referenced by MainWindowFrame::OnComboFilter(), MainWindowFrame::OnUpdateTimer(), operator=(), operator==(), and FilterTree::refreshFilterTree().

filterProgress

unsigned int ProgressData::filterProgress

Progress of filter (out of 100, or -1 for no progress information) for current filter.

Referenced by Filter::collateIons(), MainWindowFrame::OnUpdateTimer(), operator=(), operator==(), IonClipFilter::refresh(), IonColourFilter::refresh(), ExternalProgramFilter::refresh(), TransformFilter::refresh(), BoundingBoxFilter::refresh(), SpectrumPlotFilter::refresh(), IonDownsampleFilter::refresh(), RangeFileFilter::refresh(), AnnotateFilter::refresh(), IonInfoFilter::refresh(), ProfileFilter::refresh(), VoxeliseFilter::refresh(), DataLoadFilter::refresh(), ClusterAnalysisFilter::refresh(), SpatialAnalysisFilter::refresh(), FilterTree::refreshFilterTree(), ClusterAnalysisFilter::setPropFromBinding(), and SpatialAnalysisFilter::setPropFromBinding().

maxStep

unsigned int ProgressData::maxStep

Maximum steps.

Referenced by MainWindowFrame::OnUpdateTimer(), operator=(), operator==(), ExternalProgramFilter::refresh(), TransformFilter::refresh(), SpectrumPlotFilter::refresh(), IonDownsampleFilter::refresh(), RangeFileFilter::refresh(), AnnotateFilter::refresh(), VoxeliseFilter::refresh(), DataLoadFilter::refresh(), SpatialAnalysisFilter::refresh(), FilterTree::refreshFilterTree(), ClusterAnalysisFilter::setPropFromBinding(), and SpatialAnalysisFilter::setPropFromBinding().

step

unsigned int ProgressData::step

Current step.

Referenced by MainWindowFrame::OnUpdateTimer(), operator=(), operator==(), ExternalProgramFilter::refresh(), TransformFilter::refresh(), SpectrumPlotFilter::refresh(), IonDownsampleFilter::refresh(), RangeFileFilter::refresh(), AnnotateFilter::refresh(), VoxeliseFilter::refresh(), DataLoadFilter::refresh(), SpatialAnalysisFilter::refresh(), FilterTree::refreshFilterTree(), ClusterAnalysisFilter::setPropFromBinding(), and SpatialAnalysisFilter::setPropFromBinding().

stepName

std::string ProgressData::stepName

Name of current operation, if specified.

Referenced by MainWindowFrame::OnUpdateTimer(), operator=(), operator==(), ExternalProgramFilter::refresh(), TransformFilter::refresh(), SpectrumPlotFilter::refresh(), IonDownsampleFilter::refresh(), RangeFileFilter::refresh(), AnnotateFilter::refresh(), VoxeliseFilter::refresh(), DataLoadFilter::refresh(), SpatialAnalysisFilter::refresh(), ClusterAnalysisFilter::setPropFromBinding(), and SpatialAnalysisFilter::setPropFromBinding().

totalNumFilters

unsigned int ProgressData::totalNumFilters

number of filters which need processing for this update

Referenced by MainWindowFrame::OnUpdateTimer(), operator=(), operator==(), and FilterTree::refreshFilterTree().

totalProgress

unsigned int ProgressData::totalProgress

Number of filters (n) that we have processed (n out of m filters)

Referenced by MainWindowFrame::OnUpdateTimer(), operator=(), and operator==().

---

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

• filter.h
• filter.cpp