1 // Created on: 1996-02-15
2 // Created by: Christian CAILLET
3 // Copyright (c) 1996-1999 Matra Datavision
4 // Copyright (c) 1999-2014 OPEN CASCADE SAS
6 // This file is part of Open CASCADE Technology software library.
8 // This library is free software; you can redistribute it and/or modify it under
9 // the terms of the GNU Lesser General Public License version 2.1 as published
10 // by the Free Software Foundation, with special exception defined in the file
11 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
12 // distribution for complete text of the license and disclaimer of any warranty.
14 // Alternatively, this file may be used under the terms of Open CASCADE
15 // commercial license or contractual agreement.
17 #ifndef _MoniTool_Stat_HeaderFile
18 #define _MoniTool_Stat_HeaderFile
20 #include <Standard.hxx>
21 #include <Standard_DefineAlloc.hxx>
22 #include <Standard_Handle.hxx>
24 #include <Standard_Integer.hxx>
25 #include <TColStd_HArray1OfInteger.hxx>
26 #include <Standard_Real.hxx>
27 class TCollection_HAsciiString;
30 //! This class manages Statistics to be queried asynchronously.
32 //! It is organized as a stack of counters, identified by their
33 //! levels, from one to ... . Each one has a total account of
34 //! items to be counted, a count of already passed items, plus a
35 //! count of "current items". The counters of higher level play on
36 //! these current items.
37 //! For instance, if a counter has been opened for 100 items, 40
38 //! already passed, 20 current, its own percent is 40, but there
39 //! is the contribution of higher level counters, rated for 20 %
42 //! Hence, a counter is opened, items are added. Also items can be
43 //! add for sub-counter (of higher level), they will be added
44 //! definitively when the sub-counter will be closed. When the
45 //! count has ended, this counter is closed, the counter of
46 //! lower level cumulates it and goes on. As follows :
50 //! Add(..) : direct adding
52 //! AddSub (nsub) : for sub-counter
53 //! Open (nbsubs) : nbsubs for this sub-counter
55 //! Close : the sub-counter
58 //! Close : the starting counter
60 //! This means that a counter can be opened in a Stat, regardless
61 //! to the already opened ones :: this will be cumulated
63 //! A Current Stat is available, but it is possible to have others
71 //! Creates a Stat form. At start, one default phase is defined,
72 //! with one default step. Then, it suffises to start with a
73 //! count of items (and cycles if several) then record items,
74 //! to have a queryable report.
75 Standard_EXPORT MoniTool_Stat(const Standard_CString title = "");
77 //! used when starting
78 Standard_EXPORT MoniTool_Stat(const MoniTool_Stat& other);
80 Standard_EXPORT static MoniTool_Stat& Current();
82 //! Opens a new counter with a starting count of items
83 Standard_EXPORT Standard_Integer Open (const Standard_Integer nb = 100);
85 //! Adds more items to be counted by Add... on current level
86 Standard_EXPORT void OpenMore (const Standard_Integer id, const Standard_Integer nb);
88 //! Directly adds items
89 Standard_EXPORT void Add (const Standard_Integer nb = 1);
91 //! Declares a count of items to be added later. If a sub-counter
92 //! is opened, its percentage multiplies this sub-count to compute
93 //! the percent of current level
94 Standard_EXPORT void AddSub (const Standard_Integer nb = 1);
96 //! Ends the AddSub and cumulates the sub-count to current level
97 Standard_EXPORT void AddEnd();
99 Standard_EXPORT void Close (const Standard_Integer id);
101 Standard_EXPORT Standard_Integer Level() const;
103 Standard_EXPORT Standard_Real Percent (const Standard_Integer fromlev = 0) const;
118 Handle(TCollection_HAsciiString) thetit;
119 Standard_Integer thelev;
120 Handle(TColStd_HArray1OfInteger) thetot;
121 Handle(TColStd_HArray1OfInteger) thedone;
122 Handle(TColStd_HArray1OfInteger) thecurr;
133 #endif // _MoniTool_Stat_HeaderFile