Files
OCCT/src/ShapeProcessAPI/ShapeProcessAPI_ApplySequence.hxx
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

97 lines
2.9 KiB
C++

// Created on: 1999-06-22
// Created by: data exchange team
// Copyright (c) 1999 Matra Datavision
// Copyright (c) 1999-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 _ShapeProcessAPI_ApplySequence_HeaderFile
#define _ShapeProcessAPI_ApplySequence_HeaderFile
#include <Standard.hxx>
#include <Standard_DefineAlloc.hxx>
#include <Standard_Handle.hxx>
#include <TopTools_DataMapOfShapeShape.hxx>
#include <TCollection_AsciiString.hxx>
#include <Standard_CString.hxx>
#include <Standard_Boolean.hxx>
#include <TopAbs_ShapeEnum.hxx>
#include <Message_ProgressRange.hxx>
class ShapeProcess_ShapeContext;
class TopoDS_Shape;
//! Applies one of the sequence read from resource file.
class ShapeProcessAPI_ApplySequence
{
public:
DEFINE_STANDARD_ALLOC
//! Creates an object and loads resource file and sequence of
//! operators given by their names.
Standard_EXPORT ShapeProcessAPI_ApplySequence(const Standard_CString rscName, const Standard_CString seqName = "");
//! Returns object for managing resource file and sequence of
//! operators.
Standard_EXPORT Handle(ShapeProcess_ShapeContext)& Context();
//! Performs sequence of operators stored in myRsc.
//! If <fillmap> is True adds history "shape-shape" into myMap
//! for shape and its subshapes until level <until> (included).
//! If <until> is TopAbs_SHAPE, all the subshapes are considered.
Standard_EXPORT TopoDS_Shape PrepareShape (const TopoDS_Shape& shape,
const Standard_Boolean fillmap = Standard_False,
const TopAbs_ShapeEnum until = TopAbs_SHAPE,
const Message_ProgressRange& theProgress = Message_ProgressRange());
//! Clears myMap with accumulated history.
Standard_EXPORT void ClearMap();
//! Returns myMap with accumulated history.
Standard_EXPORT const TopTools_DataMapOfShapeShape& Map() const;
//! Prints result of preparation onto the messenger of the context.
//! Note that results can be accumulated from previous preparations
//! it method ClearMap was not called before PrepareShape.
Standard_EXPORT void PrintPreparationResult() const;
protected:
private:
Handle(ShapeProcess_ShapeContext) myContext;
TopTools_DataMapOfShapeShape myMap;
TCollection_AsciiString mySeq;
};
#endif // _ShapeProcessAPI_ApplySequence_HeaderFile