mirror of
https://git.dev.opencascade.org/repos/occt.git
synced 2025-04-04 18:06:22 +03:00
7e785937b3
Progress indication mechanism is refactored to support incrementing progress within multithreaded algorithms. The class Message_ProgressIndicator is only an interface to the user application. It accumulates the progress provided by progress scopes. The counter is protected by mutex for thread-safety. The new class Message_ProgressScope replacing Message_ProgressSentry should be used to advance the progress. The scopes are nested to each other to reflect the nested nature of operations. The new class Message_ProgressRange should be used to pass the progress to sub-scopes. All OCCT algorithms involving progress indication have been updated to new API. Improvements in Draw_ProgressIndicator: - Separate console mode has been added in order to make possible to put the progress into std::cout instead or in addition to the draw interpreter, instead of trigger option "-tclOutput". - Treatment of Ctrl-Break signal has been added. Now any operation can be aborted by Ctrl-C or Ctrl-Break keystroke. Added new test case 'perf fclasses progr_par' for testing of parallel work of the progress.
105 lines
3.8 KiB
C++
105 lines
3.8 KiB
C++
// Created on: 2008-06-25
|
|
// Created by: data exchange team
|
|
// Copyright (c) 2008-2014 OPEN CASCADE SAS
|
|
//
|
|
// This file is part of Open CASCADE Technology software library.
|
|
//
|
|
// This library is free software; you can redistribute it and/or modify it under
|
|
// the terms of the GNU Lesser General Public License version 2.1 as published
|
|
// by the Free Software Foundation, with special exception defined in the file
|
|
// OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
|
|
// distribution for complete text of the license and disclaimer of any warranty.
|
|
//
|
|
// Alternatively, this file may be used under the terms of Open CASCADE
|
|
// commercial license or contractual agreement.
|
|
|
|
#ifndef _Draw_ProgressIndicator_HeaderFile
|
|
#define _Draw_ProgressIndicator_HeaderFile
|
|
|
|
#include <Standard.hxx>
|
|
|
|
#include <Message_ProgressIndicator.hxx>
|
|
#include <Draw_Interpretor.hxx>
|
|
|
|
class Draw_ProgressIndicator;
|
|
DEFINE_STANDARD_HANDLE(Draw_ProgressIndicator, Message_ProgressIndicator)
|
|
|
|
//! Implements ProgressIndicator (interface provided by Message)
|
|
//! for DRAW, with possibility to output to TCL window
|
|
//! and/or trace file
|
|
class Draw_ProgressIndicator : public Message_ProgressIndicator
|
|
{
|
|
|
|
public:
|
|
|
|
|
|
//! Creates a progress indicator and remembers pointer to Draw_Interpretor
|
|
//!
|
|
//! @param 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).
|
|
Standard_EXPORT Draw_ProgressIndicator(const Draw_Interpretor& di, Standard_Real theUpdateThreshold = 1.);
|
|
|
|
//! Destructor; calls Reset()
|
|
Standard_EXPORT ~Draw_ProgressIndicator();
|
|
|
|
//! Sets tcl output mode (on/off).
|
|
Standard_EXPORT void SetTclMode (const Standard_Boolean theTclMode);
|
|
|
|
//! Gets tcl output mode (on/off).
|
|
Standard_EXPORT Standard_Boolean GetTclMode() const;
|
|
|
|
//! Sets console output mode (on/off).
|
|
//! If it is on then progress is shown in the standard output.
|
|
Standard_EXPORT void SetConsoleMode(const Standard_Boolean theMode);
|
|
|
|
//! Gets console output mode (on/off)
|
|
Standard_EXPORT Standard_Boolean GetConsoleMode() const;
|
|
|
|
//! Sets graphical output mode (on/off)
|
|
Standard_EXPORT void SetGraphMode (const Standard_Boolean theGraphMode);
|
|
|
|
//! Gets graphical output mode (on/off)
|
|
Standard_EXPORT Standard_Boolean GetGraphMode() const;
|
|
|
|
//! Clears/erases opened TCL windows if any
|
|
//! and sets myBreak to False
|
|
Standard_EXPORT virtual void Reset() Standard_OVERRIDE;
|
|
|
|
//! Defines method Show of Progress Indicator
|
|
Standard_EXPORT virtual void Show (const Message_ProgressScope& theScope,
|
|
const Standard_Boolean force = Standard_True) Standard_OVERRIDE;
|
|
|
|
//! Redefines method UserBreak of Progress Indicator
|
|
Standard_EXPORT virtual Standard_Boolean UserBreak() Standard_OVERRIDE;
|
|
|
|
//! Get/Set default value for tcl mode
|
|
Standard_EXPORT static Standard_Boolean& DefaultTclMode();
|
|
|
|
//! Get/Set default value for console mode
|
|
Standard_EXPORT static Standard_Boolean& DefaultConsoleMode();
|
|
|
|
//! Get/Set default value for graph mode
|
|
Standard_EXPORT static Standard_Boolean& DefaultGraphMode();
|
|
|
|
//! Internal method for implementation of UserBreak mechanism;
|
|
//! note that it uses static variable and thus not thread-safe!
|
|
Standard_EXPORT static Standard_Address& StopIndicator();
|
|
|
|
DEFINE_STANDARD_RTTIEXT(Draw_ProgressIndicator,Message_ProgressIndicator)
|
|
|
|
private:
|
|
Standard_Boolean myTclMode;
|
|
Standard_Boolean myConsoleMode;
|
|
Standard_Boolean myGraphMode;
|
|
Draw_Interpretor* myDraw;
|
|
Standard_Boolean myShown;
|
|
Standard_Boolean myBreak;
|
|
Standard_Real myUpdateThreshold;
|
|
Standard_Real myLastPosition;
|
|
Standard_Size myStartTime;
|
|
Standard_ThreadId myGuiThreadId;
|
|
};
|
|
|
|
#endif // _Draw_ProgressIndicator_HeaderFile
|