Interface_STAT.hxx File Reference

#include <Standard.hxx>
#include <Standard_Macro.hxx>
#include <Handle_TCollection_HAsciiString.hxx>
#include <Standard_Real.hxx>
#include <Handle_TColStd_HSequenceOfAsciiString.hxx>
#include <Handle_TColStd_HSequenceOfReal.hxx>
#include <Handle_TColStd_HSequenceOfInteger.hxx>
#include <Standard_CString.hxx>
#include <Standard_Integer.hxx>
#include <Standard_Boolean.hxx>

Data Structures

class Interface_STAT

This class manages statistics to be queried asynchronously.
Way of use :
An operator describes a STAT form then fills it according to
its progression. This produces a state of advancement of the
process. This state can then be queried asynchronously :
typically it is summarised as a percentage. There are also
an identification of the current state, and informations on
processed volume.

A STAT form can be described once for all (as static).
It describes the stream of the process (see later), in terms
of phases, cycles, steps, with estimated weights. But it
brings no current data.

One STAT at a time is active for filling and querying. It is
used to control phasing, weighting ... Specific data for
execution are given when running on active STAT : counts of
items ... Data for query are then recorded and can be accessed
at any time, asynchronously.

A STAT is organised as follows :

it can be split into PHASES (by default, there is none, and
all process takes place in one "default" phase)
each phase is identified by a name and is attached a weight
-> the sum of the weights is used to compute relative weights
for each phase, or for the unique default phase if none :
-- the process works on a list of ITEMS
-- by default, all the items are processed in once
-- but this list can be split into CYCLES, each one takes
a sub-list : the weight of each cycle is related to its
count of items
-- a cycle can be split into STEPS, by default there are none
then one "default step" is considered
-- each step is attached a weight
-> the sum of the weights of steps is used to compute relative
weights of the steps in each cycle
-> all the cycles of a phase have the same organisation

Hence, when defining the STAT form, the phases have to be
described. If no weight is precisely known, give 1. for all...
No phase description will give only one "default" phase
For each phase, a typical cycle can be described by its steps.
Here too, for no weight precisely known, give 1. for all...

For executing, activate a STAT to begin count. Give counts of
items and cycles for the first phase (for the unique default
one if no phasing is described)
Else, give count of items and cycles for each new phase.
Class methods allow also to set next cycle (given count of
items), next step in cycle (if more then one), next item in
step.

More...