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:

[legend]

Public Member Functions
	Draw_ProgressIndicator (const Draw_Interpretor &di, Standard_Real theUpdateThreshold=1.)
	Creates a progress indicator and remembers pointer to Draw_Interpretor.

	~Draw_ProgressIndicator ()
	Destructor; calls Reset()

void	SetTclMode (const Standard_Boolean theTclMode)
	Sets tcl output mode (on/off).

Standard_Boolean	GetTclMode () const
	Gets tcl output mode (on/off).

void	SetConsoleMode (const Standard_Boolean theMode)
	Sets console output mode (on/off). If it is on then progress is shown in the standard output.

Standard_Boolean	GetConsoleMode () const
	Gets console output mode (on/off)

void	SetGraphMode (const Standard_Boolean theGraphMode)
	Sets graphical output mode (on/off)

Standard_Boolean	GetGraphMode () const
	Gets graphical output mode (on/off)

virtual void	Reset () override
	Clears/erases opened TCL windows if any and sets myBreak to False.

virtual void	Show (const Message_ProgressScope &theScope, const Standard_Boolean force=Standard_True) override
	Defines method Show of Progress Indicator.

virtual Standard_Boolean	UserBreak () override
	Redefines method UserBreak of Progress Indicator.

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().

	~Message_ProgressIndicator ()
	Destructor.

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.

Public Member Functions inherited from Standard_Transient
	Standard_Transient ()
	Empty constructor.

	Standard_Transient (const Standard_Transient &)
	Copy constructor – does nothing.

Standard_Transient &	operator= (const Standard_Transient &)
	Assignment operator, needed to avoid copying reference counter.

virtual	~Standard_Transient ()
	Destructor must be virtual.

virtual const opencascade::handle< Standard_Type > &	DynamicType () const
	Returns a type descriptor about this object.

Standard_Boolean	IsInstance (const opencascade::handle< Standard_Type > &theType) const
	Returns a true value if this is an instance of Type.

Standard_Boolean	IsInstance (const Standard_CString theTypeName) const
	Returns a true value if this is an instance of TypeName.

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.

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.

Standard_Transient *	This () 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.

Standard_Integer	GetRefCount () const noexcept
	Get the reference counter of this object.

void	IncrementRefCounter () noexcept
	Increments the reference counter of this object.

Standard_Integer	DecrementRefCounter () noexcept
	Decrements the reference counter of this object; returns the decremented value.

virtual void	Delete () const
	Memory deallocator for transient classes.

Static Public Member Functions
static Standard_Boolean &	DefaultTclMode ()
	Get/Set default value for tcl mode.

static Standard_Boolean &	DefaultConsoleMode ()
	Get/Set default value for console mode.

static Standard_Boolean &	DefaultGraphMode ()
	Get/Set default value for graph mode.

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

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.

Static Public Member Functions inherited from Standard_Transient
static constexpr const char *	get_type_name ()
	Returns a type descriptor about this object.

static const opencascade::handle< Standard_Type > &	get_type_descriptor ()
	Returns type descriptor of Standard_Transient class.

Additional Inherited Members
Public Types inherited from Standard_Transient
typedef void	base_type
	Returns a type descriptor about this object.

Protected Member Functions inherited from Message_ProgressIndicator
	Message_ProgressIndicator ()
	Constructor.

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

theUpdateThreshold defines 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:

Draw_ProgressIndicator.hxx

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Draw_ProgressIndicator()

◆ ~Draw_ProgressIndicator()

Member Function Documentation

◆ DefaultConsoleMode()

◆ DefaultGraphMode()

◆ DefaultTclMode()

◆ GetConsoleMode()

◆ GetGraphMode()

◆ GetTclMode()

◆ Reset()

◆ SetConsoleMode()

◆ SetGraphMode()

◆ SetTclMode()

◆ Show()

◆ StopIndicator()

◆ UserBreak()