Message_ProgressRange Class Reference

Auxiliary class representing a part of the global progress scale allocated by a step of the progress scope, see Message_ProgressScope::Next(). More...

#include <Message_ProgressRange.hxx>

Public Member Functions
	Message_ProgressRange ()
	Constructor of the empty range. More...
	Message_ProgressRange (const Message_ProgressRange &theOther)
	Copy constructor disarms the source. More...
Message_ProgressRange &	operator= (const Message_ProgressRange &theOther)
	Copy assignment disarms the source. More...
Standard_Boolean	UserBreak () const
	Returns true if ProgressIndicator signals UserBreak. More...
Standard_Boolean	More () const
	Returns false if ProgressIndicator signals UserBreak. More...
Standard_Boolean	IsActive () const
	Returns true if this progress range is attached to some indicator. More...
void	Close ()
	Closes the current range and advances indicator. More...
	~Message_ProgressRange ()
	Destructor. More...

Detailed Description

Auxiliary class representing a part of the global progress scale allocated by a step of the progress scope, see Message_ProgressScope::Next().

A range object takes responsibility of advancing the progress by the size of allocated step, which is then performed depending on how it is used:

• If Message_ProgressScope object is created using this range as argument, then this respondibility is taken over by that scope.
• Otherwise, a range advances progress directly upon destruction.

A range object can be copied, the responsibility for progress advancement is then taken by the copy. The same range object may be used (either copied or used to create scope) only once. Any consequent attempts to use range will give no result on the progress; in debug mode, an assert message will be generated.

See also

Message_ProgressScope for more details

Constructor & Destructor Documentation

Message_ProgressRange() [1/2]

Message_ProgressRange::Message_ProgressRange ( )

inline

Constructor of the empty range.

Message_ProgressRange() [2/2]

Message_ProgressRange::Message_ProgressRange ( const Message_ProgressRange &  theOther )

inline

Copy constructor disarms the source.

~Message_ProgressRange()

Message_ProgressRange::~Message_ProgressRange ( )

inline

Destructor.

Member Function Documentation

Close()

void Message_ProgressRange::Close ( )

inline

Closes the current range and advances indicator.

IsActive()

Standard_Boolean Message_ProgressRange::IsActive ( ) const

inline

Returns true if this progress range is attached to some indicator.

More()

Standard_Boolean Message_ProgressRange::More ( void  ) const

inline

Returns false if ProgressIndicator signals UserBreak.

operator=()

Message_ProgressRange& Message_ProgressRange::operator= ( const Message_ProgressRange &  theOther )

inline

Copy assignment disarms the source.

UserBreak()

Standard_Boolean Message_ProgressRange::UserBreak ( ) const

inline

Returns true if ProgressIndicator signals UserBreak.

---

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

• Message_ProgressRange.hxx