mirror of
https://git.dev.opencascade.org/repos/occt.git
synced 2025-04-03 17:56:21 +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.
161 lines
4.9 KiB
C++
161 lines
4.9 KiB
C++
// Created on: 1995-11-13
|
|
// Created by: Jean-Louis Frenkel
|
|
// Copyright (c) 1995-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 _CDF_Store_HeaderFile
|
|
#define _CDF_Store_HeaderFile
|
|
|
|
#include <Standard.hxx>
|
|
#include <Standard_DefineAlloc.hxx>
|
|
#include <Standard_Handle.hxx>
|
|
|
|
#include <Standard_Boolean.hxx>
|
|
#include <TCollection_ExtendedString.hxx>
|
|
#include <PCDM_StoreStatus.hxx>
|
|
#include <CDF_TryStoreStatus.hxx>
|
|
#include <Standard_ExtString.hxx>
|
|
#include <CDF_StoreSetNameStatus.hxx>
|
|
#include <CDF_SubComponentStatus.hxx>
|
|
#include <TCollection_HExtendedString.hxx>
|
|
|
|
#include <Message_ProgressRange.hxx>
|
|
|
|
class CDF_StoreList;
|
|
class CDM_Document;
|
|
class TCollection_ExtendedString;
|
|
|
|
|
|
|
|
class CDF_Store
|
|
{
|
|
public:
|
|
|
|
DEFINE_STANDARD_ALLOC
|
|
|
|
|
|
//! creates a store list from the document of the current selection.
|
|
Standard_EXPORT CDF_Store(const Handle(CDM_Document)& aDocument);
|
|
|
|
//! returns the folder in which the current document will be stored.
|
|
Standard_EXPORT Handle(TCollection_HExtendedString) Folder() const;
|
|
|
|
//! returns the name under which the current document will be stored
|
|
Standard_EXPORT Handle(TCollection_HExtendedString) Name() const;
|
|
|
|
//! returns true if the current document is already stored
|
|
Standard_EXPORT Standard_Boolean IsStored() const;
|
|
|
|
Standard_EXPORT Standard_Boolean IsModified() const;
|
|
|
|
Standard_EXPORT Standard_Boolean CurrentIsConsistent() const;
|
|
|
|
Standard_EXPORT Standard_Boolean IsConsistent() const;
|
|
|
|
Standard_EXPORT Standard_Boolean HasAPreviousVersion() const;
|
|
|
|
Standard_EXPORT Handle(TCollection_HExtendedString) PreviousVersion() const;
|
|
|
|
//! returns true if the currentdocument is the main one, ie the document
|
|
//! of the current selection.
|
|
Standard_EXPORT Standard_Boolean IsMainDocument() const;
|
|
|
|
//! defines the folder in which the document should be
|
|
//! stored. returns Standard_True if the Folder exists,
|
|
//! Standard_False otherwise.
|
|
Standard_EXPORT Standard_Boolean SetFolder (const TCollection_ExtendedString& aFolder);
|
|
|
|
//! defines the name under which the document should be stored.
|
|
Standard_EXPORT CDF_StoreSetNameStatus SetName (const Standard_ExtString aName);
|
|
|
|
Standard_EXPORT void SetComment (const Standard_ExtString aComment);
|
|
|
|
Standard_EXPORT Handle(TCollection_HExtendedString) Comment() const;
|
|
|
|
//! defines the name under which the document should be stored.
|
|
//! uses for example after modification of the folder.
|
|
Standard_EXPORT CDF_StoreSetNameStatus RecheckName();
|
|
|
|
Standard_EXPORT Standard_Boolean SetPreviousVersion (const Standard_ExtString aPreviousVersion);
|
|
|
|
Standard_EXPORT void Realize (const Message_ProgressRange& theRange = Message_ProgressRange());
|
|
|
|
//! returns the complete path of the created meta-data.
|
|
Standard_EXPORT Standard_ExtString Path() const;
|
|
|
|
//! returns the path of the previous store is the object
|
|
//! is already stored, otherwise an empty string;
|
|
Standard_EXPORT Handle(TCollection_HExtendedString) MetaDataPath() const;
|
|
|
|
//! returns the description of the format of the main object.
|
|
Standard_EXPORT Handle(TCollection_HExtendedString) Description() const;
|
|
|
|
Standard_EXPORT void SetCurrent (const Standard_ExtString aPresentation);
|
|
|
|
//! the two following methods can
|
|
//! be used just after Realize or Import -- method to know if
|
|
//! thes methods worked correctly, and if not why.
|
|
Standard_EXPORT void SetMain();
|
|
|
|
Standard_EXPORT PCDM_StoreStatus StoreStatus() const;
|
|
|
|
Standard_EXPORT Standard_ExtString AssociatedStatusText() const;
|
|
|
|
//! defines the name under which the document should be stored.
|
|
Standard_EXPORT CDF_StoreSetNameStatus SetName (const TCollection_ExtendedString& aName);
|
|
|
|
//! defines the folder in which the document should be
|
|
//! stored. returns Standard_True if the Folder exists,
|
|
//! Standard_False otherwise.
|
|
Standard_EXPORT Standard_Boolean SetFolder (const Standard_ExtString aFolder);
|
|
|
|
|
|
|
|
|
|
protected:
|
|
|
|
|
|
|
|
|
|
|
|
private:
|
|
|
|
|
|
Standard_EXPORT CDF_Store();
|
|
|
|
Standard_EXPORT void FindDefault();
|
|
|
|
Standard_EXPORT void Init();
|
|
|
|
|
|
Handle(CDF_StoreList) myList;
|
|
Handle(CDM_Document) myMainDocument;
|
|
Handle(CDM_Document) myCurrentDocument;
|
|
Standard_Boolean myHasSubComponents;
|
|
Standard_Boolean myIsMainDocument;
|
|
TCollection_ExtendedString myPath;
|
|
TCollection_ExtendedString myText;
|
|
PCDM_StoreStatus myStatus;
|
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
#endif // _CDF_Store_HeaderFile
|