cvr::progressReporter Class Reference
[Programming interfaces]

Interface for all objects that provide progressInfo interface. More...

#include <cvrProgressReporter.h>

Collaboration diagram for cvr::progressReporter:

[legend]

List of all members.

Public Member Functions
	progressReporter ()
	progressReporter (const progressReporter &other)
virtual	~progressReporter ()
progressReporter &	copy (const progressReporter &other)
progressReporter &	operator= (const progressReporter &other)
progressReporter *	clone () const
progressReporter *	newInstance () const
void	setProgressObject (const progressInfo &progress)
void	removeProgressObject ()
bool	haveValidProgressObject () const
bool	haveValidProgressObject (const int detailLevel) const
const progressInfo &	getProgressObject () const
progressInfo &	getProgressObject ()
Protected Attributes
progressInfo *	progressObject_

---

Detailed Description

Interface for all objects that provide progressInfo interface.

---

Constructor & Destructor Documentation

cvr::progressReporter::progressReporter

(

)

Default destructor.

cvr::progressReporter::progressReporter

(

const progressReporter &

other

)

Copy destructor.

virtual cvr::progressReporter::~progressReporter

(

)

[virtual]

Destructor.

---

Member Function Documentation

progressReporter* cvr::progressReporter::clone

(

)

const

Return a pointer to a clone of this progressReporter.

progressReporter& cvr::progressReporter::copy

(

const progressReporter &

other

)

Copy the other progressReporter.

progressInfo& cvr::progressReporter::getProgressObject

(

)

Get a modifiable reference to the progressInfo object.

const progressInfo& cvr::progressReporter::getProgressObject

(

)

const

Get a read-only reference to the progressInfo object.

bool cvr::progressReporter::haveValidProgressObject

(

const int

detailLevel

)

const

Return true if a valid progressInfo object has already been set, and if its detail level is greater or equal the given value.

bool cvr::progressReporter::haveValidProgressObject

(

)

const

Return true if a valid progressInfo object has already been set.

progressReporter* cvr::progressReporter::newInstance

(

)

const

Return a pointer to a new instance of this progressReporter.

progressReporter& cvr::progressReporter::operator=

(

const progressReporter &

other

)

Copy the other progressReporter.

void cvr::progressReporter::removeProgressObject

(

)

Remove the active progressInfo object.

void cvr::progressReporter::setProgressObject

(

const progressInfo &

progress

)

Set the progressInfo object to be used.

A clone of the given object will be generated.

---

Member Data Documentation

progressInfo* cvr::progressReporter::progressObject_ [protected]

The current progressInfo object.

---

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

• cvrProgressReporter.h