Open CASCADE Technology  7.7.0.dev
Public Member Functions | Static Public Member Functions

Draw_ProgressIndicator Class Reference

Implements ProgressIndicator (interface provided by Message) for DRAW, with possibility to output to TCL window and/or trace file. More...

#include <Draw_ProgressIndicator.hxx>

Inheritance diagram for Draw_ProgressIndicator:
Inheritance graph
[legend]

Public Member Functions

 Draw_ProgressIndicator (const Draw_Interpretor &di, Standard_Real theUpdateThreshold=1.)
 Creates a progress indicator and remembers pointer to Draw_Interpretor. More...
 
 ~Draw_ProgressIndicator ()
 Destructor; calls Reset() More...
 
void SetTclMode (const Standard_Boolean theTclMode)
 Sets tcl output mode (on/off). More...
 
Standard_Boolean GetTclMode () const
 Gets tcl output mode (on/off). More...
 
void SetConsoleMode (const Standard_Boolean theMode)
 Sets console output mode (on/off). If it is on then progress is shown in the standard output. More...
 
Standard_Boolean GetConsoleMode () const
 Gets console output mode (on/off) More...
 
void SetGraphMode (const Standard_Boolean theGraphMode)
 Sets graphical output mode (on/off) More...
 
Standard_Boolean GetGraphMode () const
 Gets graphical output mode (on/off) More...
 
virtual void Reset () override
 Clears/erases opened TCL windows if any and sets myBreak to False. More...
 
virtual void Show (const Message_ProgressScope &theScope, const Standard_Boolean force=Standard_True) override
 Defines method Show of Progress Indicator. More...
 
virtual Standard_Boolean UserBreak () override
 Redefines method UserBreak of Progress Indicator. More...
 
- Public Member Functions inherited from Message_ProgressIndicator
Standard_Real GetPosition () const
 Returns total progress position ranged from 0 to 1. Should not be called concurrently while the progress is advancing, except from implementation of method Show(). More...
 
 ~Message_ProgressIndicator ()
 Destructor. More...
 
Message_ProgressRange Start ()
 Resets the indicator to zero, calls Reset(), and returns the range. This range refers to the scope that has no name and is initialized with max value 1 and step 1. Use this method to get the top level range for progress indication. More...
 
- Public Member Functions inherited from Standard_Transient
 Standard_Transient ()
 Empty constructor. More...
 
 Standard_Transient (const Standard_Transient &)
 Copy constructor – does nothing. More...
 
Standard_Transientoperator= (const Standard_Transient &)
 Assignment operator, needed to avoid copying reference counter. More...
 
virtual ~Standard_Transient ()
 Destructor must be virtual. More...
 
virtual void Delete () const
 Memory deallocator for transient classes. More...
 
virtual const opencascade::handle< Standard_Type > & DynamicType () const
 Returns a type descriptor about this object. More...
 
Standard_Boolean IsInstance (const opencascade::handle< Standard_Type > &theType) const
 Returns a true value if this is an instance of Type. More...
 
Standard_Boolean IsInstance (const Standard_CString theTypeName) const
 Returns a true value if this is an instance of TypeName. More...
 
Standard_Boolean IsKind (const opencascade::handle< Standard_Type > &theType) const
 Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism. More...
 
Standard_Boolean IsKind (const Standard_CString theTypeName) const
 Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism. More...
 
Standard_TransientThis () const
 Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero. More...
 
Standard_Integer GetRefCount () const
 Get the reference counter of this object. More...
 
void IncrementRefCounter () const
 Increments the reference counter of this object. More...
 
Standard_Integer DecrementRefCounter () const
 Decrements the reference counter of this object; returns the decremented value. More...
 

Static Public Member Functions

static Standard_BooleanDefaultTclMode ()
 Get/Set default value for tcl mode. More...
 
static Standard_BooleanDefaultConsoleMode ()
 Get/Set default value for console mode. More...
 
static Standard_BooleanDefaultGraphMode ()
 Get/Set default value for graph mode. More...
 
static Standard_AddressStopIndicator ()
 Internal method for implementation of UserBreak mechanism; note that it uses static variable and thus not thread-safe! More...
 
- Static Public Member Functions inherited from Message_ProgressIndicator
static Message_ProgressRange Start (const Handle< Message_ProgressIndicator > &theProgress)
 If argument is non-null handle, returns theProgress->Start(). Otherwise, returns dummy range that can be safely used in the algorithms but not bound to progress indicator. More...
 
- Static Public Member Functions inherited from Standard_Transient
static const char * get_type_name ()
 Returns a type descriptor about this object. More...
 
static const opencascade::handle< Standard_Type > & get_type_descriptor ()
 Returns type descriptor of Standard_Transient class. More...
 

Additional Inherited Members

- Public Types inherited from Standard_Transient
typedef void base_type
 Returns a type descriptor about this object. More...
 
- Protected Member Functions inherited from Message_ProgressIndicator
 Message_ProgressIndicator ()
 Constructor. More...
 

Detailed Description

Implements ProgressIndicator (interface provided by Message) for DRAW, with possibility to output to TCL window and/or trace file.

Constructor & Destructor Documentation

◆ Draw_ProgressIndicator()

Draw_ProgressIndicator::Draw_ProgressIndicator ( const Draw_Interpretor di,
Standard_Real  theUpdateThreshold = 1. 
)

Creates a progress indicator and remembers pointer to Draw_Interpretor.

Parameters
theUpdateThresholddefines minimal progress (in percents) between updates of the indicator (non-forced updates of the progress bar will be disabled until that progress is reached since last update).

◆ ~Draw_ProgressIndicator()

Draw_ProgressIndicator::~Draw_ProgressIndicator ( )

Destructor; calls Reset()

Member Function Documentation

◆ DefaultConsoleMode()

static Standard_Boolean& Draw_ProgressIndicator::DefaultConsoleMode ( )
static

Get/Set default value for console mode.

◆ DefaultGraphMode()

static Standard_Boolean& Draw_ProgressIndicator::DefaultGraphMode ( )
static

Get/Set default value for graph mode.

◆ DefaultTclMode()

static Standard_Boolean& Draw_ProgressIndicator::DefaultTclMode ( )
static

Get/Set default value for tcl mode.

◆ GetConsoleMode()

Standard_Boolean Draw_ProgressIndicator::GetConsoleMode ( ) const

Gets console output mode (on/off)

◆ GetGraphMode()

Standard_Boolean Draw_ProgressIndicator::GetGraphMode ( ) const

Gets graphical output mode (on/off)

◆ GetTclMode()

Standard_Boolean Draw_ProgressIndicator::GetTclMode ( ) const

Gets tcl output mode (on/off).

◆ Reset()

virtual void Draw_ProgressIndicator::Reset ( )
overridevirtual

Clears/erases opened TCL windows if any and sets myBreak to False.

Reimplemented from Message_ProgressIndicator.

◆ SetConsoleMode()

void Draw_ProgressIndicator::SetConsoleMode ( const Standard_Boolean  theMode)

Sets console output mode (on/off). If it is on then progress is shown in the standard output.

◆ SetGraphMode()

void Draw_ProgressIndicator::SetGraphMode ( const Standard_Boolean  theGraphMode)

Sets graphical output mode (on/off)

◆ SetTclMode()

void Draw_ProgressIndicator::SetTclMode ( const Standard_Boolean  theTclMode)

Sets tcl output mode (on/off).

◆ Show()

virtual void Draw_ProgressIndicator::Show ( const Message_ProgressScope theScope,
const Standard_Boolean  force = Standard_True 
)
overridevirtual

Defines method Show of Progress Indicator.

Implements Message_ProgressIndicator.

◆ StopIndicator()

static Standard_Address& Draw_ProgressIndicator::StopIndicator ( )
static

Internal method for implementation of UserBreak mechanism; note that it uses static variable and thus not thread-safe!

◆ UserBreak()

virtual Standard_Boolean Draw_ProgressIndicator::UserBreak ( )
overridevirtual

Redefines method UserBreak of Progress Indicator.

Reimplemented from Message_ProgressIndicator.


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