1
0
mirror of https://git.dev.opencascade.org/repos/occt.git synced 2025-05-06 10:36:12 +03:00
occt/src/BOPAlgo/BOPAlgo_Options.cxx
msv 7e785937b3 0025748: Parallel version of progress indicator
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.
2020-09-12 20:42:22 +03:00

156 lines
4.7 KiB
C++

// Created by: Eugeny MALTCHIKOV
// Copyright (c) 2017 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.
#include <BOPAlgo_Options.hxx>
#include <Message_MsgFile.hxx>
#include <Message_ProgressScope.hxx>
#include <NCollection_BaseAllocator.hxx>
#include <TCollection_AsciiString.hxx>
#include <Precision.hxx>
#include <Standard_NotImplemented.hxx>
#include <Standard_ProgramError.hxx>
namespace
{
Standard_Boolean myGlobalRunParallel = Standard_False;
// Initialize textual messages for errors and warnings defined in BOPAlgo
#include "BOPAlgo_BOPAlgo_msg.pxx"
bool BOPAlgo_InitMessages = false;
void BOPAlgo_LoadMessages ()
{
if (BOPAlgo_InitMessages)
return;
BOPAlgo_InitMessages = true;
if (! Message_MsgFile::HasMsg ("BOPAlgo_LOAD_CHECKER"))
{
Message_MsgFile::LoadFromString (BOPAlgo_BOPAlgo_msg);
}
}
}
//=======================================================================
// function:
// purpose:
//=======================================================================
BOPAlgo_Options::BOPAlgo_Options()
:
myAllocator(NCollection_BaseAllocator::CommonBaseAllocator()),
myReport(new Message_Report),
myRunParallel(myGlobalRunParallel),
myFuzzyValue(Precision::Confusion()),
myProgressScope(0L),
myUseOBB(Standard_False)
{
BOPAlgo_LoadMessages();
}
//=======================================================================
// function:
// purpose:
//=======================================================================
BOPAlgo_Options::BOPAlgo_Options
(const Handle(NCollection_BaseAllocator)& theAllocator)
:
myAllocator(theAllocator),
myReport(new Message_Report),
myRunParallel(myGlobalRunParallel),
myFuzzyValue(Precision::Confusion()),
myProgressScope(0L),
myUseOBB(Standard_False)
{
BOPAlgo_LoadMessages();
}
//=======================================================================
// function: ~
// purpose:
//=======================================================================
BOPAlgo_Options::~BOPAlgo_Options()
{
}
//=======================================================================
//function : DumpErrors
//purpose :
//=======================================================================
void BOPAlgo_Options::DumpErrors(Standard_OStream& theOS) const
{
myReport->Dump (theOS, Message_Fail);
}
//=======================================================================
//function : DumpWarnings
//purpose :
//=======================================================================
void BOPAlgo_Options::DumpWarnings(Standard_OStream& theOS) const
{
myReport->Dump (theOS, Message_Warning);
}
//=======================================================================
// function:
// purpose:
//=======================================================================
void BOPAlgo_Options::SetParallelMode(Standard_Boolean theNewMode)
{
myGlobalRunParallel = theNewMode;
}
//=======================================================================
// function:
// purpose:
//=======================================================================
Standard_Boolean BOPAlgo_Options::GetParallelMode()
{
return myGlobalRunParallel;
}
//=======================================================================
//function : SetFuzzyValue
//purpose :
//=======================================================================
void BOPAlgo_Options::SetFuzzyValue(const Standard_Real theFuzz)
{
myFuzzyValue = Max(theFuzz, Precision::Confusion());
}
//=======================================================================
//function : SetProgressIndicator
//purpose :
//=======================================================================
void BOPAlgo_Options::SetProgressIndicator
(const Message_ProgressScope& theScope)
{
myProgressScope = &theScope;
}
//=======================================================================
//function : UserBreak
//purpose :
//=======================================================================
void BOPAlgo_Options::UserBreak() const
{
if (!myProgressScope) {
return;
}
if (myProgressScope->UserBreak()) {
throw Standard_NotImplemented("BOPAlgo_Options::UserBreak(), method is not implemented");
}
}