Functionality of this class (Message_ProgressSentry) has been superseded by Message_ProgressScope. This class is kept just to simplify transition of an old code and will be removed in future. More...
#include <Message_ProgressSentry.hxx>
Inheritance diagram for Message_ProgressSentry:
Public Member Functions | |
| Message_ProgressSentry (const Message_ProgressRange &theRange, const Standard_CString theName, const Standard_Real theMin, const Standard_Real theMax, const Standard_Real theStep, const Standard_Boolean theIsInf=Standard_False, const Standard_Real theNewScopeSpan=0.0) | |
| Deprecated constructor, Message_ProgressScope should be created instead. | |
| void | Relieve () |
| Method Relieve() was replaced by Close() in Message_ProgressScope. | |
 Public Member Functions inherited from Message_ProgressScope | |
| Message_ProgressScope () | |
| Creates dummy scope. It can be safely passed to algorithms; no progress indication will be done. | |
| Message_ProgressScope (const Message_ProgressRange &theRange, const TCollection_AsciiString &theName, Standard_Real theMax, Standard_Boolean isInfinite=false) | |
| Creates a new scope taking responsibility of the part of the progress scale described by theRange. The new scope has own range from 0 to theMax, which is mapped to the given range. | |
| template<size_t N> | |
| Message_ProgressScope (const Message_ProgressRange &theRange, const char(&theName)[N], Standard_Real theMax, Standard_Boolean isInfinite=false) | |
| Creates a new scope taking responsibility of the part of the progress scale described by theRange. The new scope has own range from 0 to theMax, which is mapped to the given range. | |
| Message_ProgressScope (const Message_ProgressRange &theRange, const NullString *theName, Standard_Real theMax, Standard_Boolean isInfinite=false) | |
| Creates a new scope taking responsibility of the part of the progress scale described by theRange. The new scope has own range from 0 to theMax, which is mapped to the given range. | |
| void | SetName (const TCollection_AsciiString &theName) |
| Sets the name of the scope. | |
| template<size_t N> | |
| void | SetName (const char(&theName)[N]) |
| Sets the name of the scope; can be null. Note! Just pointer to the given string is copied, so do not pass string from a temporary variable whose lifetime is less than that of this object. | |
| Standard_Boolean | UserBreak () const |
| Returns true if ProgressIndicator signals UserBreak. | |
| Standard_Boolean | More () const |
| Returns false if ProgressIndicator signals UserBreak. | |
| Message_ProgressRange | Next (Standard_Real theStep=1.) |
| Advances position by specified step and returns the range covering this step. | |
| void | Show () |
| Force update of presentation of the progress indicator. Should not be called concurrently. | |
| Standard_Boolean | IsActive () const |
| Returns true if this progress scope is attached to some indicator. | |
| Standard_CString | Name () const |
| Returns the name of the scope (may be null). Scopes with null name (e.g. root scope) should be bypassed when reporting progress to the user. | |
| const Message_ProgressScope * | Parent () const |
| Returns parent scope (null for top-level scope) | |
| Standard_Real | MaxValue () const |
| Returns the maximal value of progress in this scope. | |
| Standard_Real | Value () const |
| Returns the current value of progress in this scope. | |
| Standard_Boolean | IsInfinite () const |
| Returns the infinite flag. | |
| Standard_Real | GetPortion () const |
| Get the portion of the indicator covered by this scope (from 0 to 1) | |
| ~Message_ProgressScope () | |
| Destructor - closes the scope and adds its scale to the total progress. | |
| void | Close () |
| Closes the scope and advances the progress to its end. Closed scope should not be used. | |
Detailed Description
Functionality of this class (Message_ProgressSentry) has been superseded by Message_ProgressScope. This class is kept just to simplify transition of an old code and will be removed in future.
Constructor & Destructor Documentation
◆ Message_ProgressSentry()
|
inline |
Deprecated constructor, Message_ProgressScope should be created instead.
Member Function Documentation
◆ Relieve()
|
inline |
Method Relieve() was replaced by Close() in Message_ProgressScope.
The documentation for this class was generated from the following file:
