Abstract base class for extraction callback interfaces. More...
#include <MeshVizXLM/extractors/MiExtractorCallback.h>
Public Member Functions | |
virtual | ~MiExtractorCallback () |
virtual void | beginExtract (const std::string extractorName, bool geomChanged, bool topoChanged, bool dataSetChanged, size_t numPhases)=0 |
virtual void | endExtract ()=0 |
virtual bool | beginPhase (size_t phaseId, std::string phaseName, size_t numIterationInPhase)=0 |
virtual bool | endPhase ()=0 |
virtual bool | endStep (size_t numIterationDone)=0 |
virtual double | getEndStepCallPeriod ()=0 |
This abstract class specifies the interface used by extractors to notify the application when an extraction starts, stops or when it is in progress. For instance this class allows an update of any kind of progress bar.
An extraction is conceptually divided into sequential phases and each phase has multiple iteration steps.
When an extraction starts, MeshViz calls the beginExtract() method. The number of phases in the extraction is passed to this method. When the extraction is complete, MeshViz will call the endExtract() method. However due to possible nested extractions, beginExtract() and endExtract() calls may occur several times during an extraction process. Both methods are called the same number of times. Therefore monitoring the end of an overall extraction can be performed by incrementing a counter on beginExtract() calls and decreasing it on endExtract() calls.
A phase is a logical part of the job of the extraction. The number of phases is passed to the beginExtract() method. When a phase starts, MeshViz calls the beginPhase() method with an id and a name for the phase as well as the number of iteration steps in the phase. When the phase is complete, MeshViz will call the endPhase() method. During a phase, MeshViz will call the endStep() method with the number of iteration steps completed. The percentage of the phase completed is this value divided by the number of iteration steps in the phase. The number of calls to endStep() during a phase is controlled by (or at least influenced by) the value returned from the application's getEndStepCallPeriod().
The value returned by getEndStepCallPeriod() is just a suggestion to MeshViz. MeshViz controls the number of calls to endStep() in order to prevent a large increase of the total time of extraction. If the phase needs a small number of iteration steps, (for instance a small number of cells in the mesh) then endStep() is probably never called even if getEndStepCallPeriod() returned a small value.
Each phase could be associated to a single progress bar. If the application uses only one progress bar, the progress bar can be initialized in the implementation of beginPhase(), and it can be closed in the implementation of endPhase(). The progress bar can be updated at regular steps with the implementation of endStep().
MeshViz may interrupt a phase with an early call to endPhase() and even restart a phase if necessary by calling beginPhase() with the same phase identifier but possibly a different number of iterations.
The return values of beginPhase(), endPhase() and endStep() are not used yet. We advise to return true by default.
virtual MiExtractorCallback::~MiExtractorCallback | ( | ) | [inline, virtual] |
virtual void MiExtractorCallback::beginExtract | ( | const std::string | extractorName, | |
bool | geomChanged, | |||
bool | topoChanged, | |||
bool | dataSetChanged, | |||
size_t | numPhases | |||
) | [pure virtual] |
This method is called each time a new extraction starts and only if the mesh, the cell filter, the tessellator or the data sets have changed since the last extraction.
extractorName | name of this extraction. | |
geomChanged | true if the geometry of the extracted mesh must be updated. | |
topoChanged | true if the topology of the extracted mesh must be updated. | |
dataSetChanged | true if the data sets associated to the extracted mesh must be updated. | |
numPhases | number of phases that will be done by this extraction. |
virtual bool MiExtractorCallback::beginPhase | ( | size_t | phaseId, | |
std::string | phaseName, | |||
size_t | numIterationInPhase | |||
) | [pure virtual] |
This method is called each time a new phase of the current extraction starts.
phaseId | id of this new phase. | |
phaseName | name of this phase. | |
numIterationInPhase | number of iterations that will be executed during this phase. |
virtual void MiExtractorCallback::endExtract | ( | ) | [pure virtual] |
This method is called each time a new extraction ends and only if the mesh, the cell filters, the tessellator or the data sets have changed since the last extraction.
After this call, the extracted mesh has been updated and can then be parsed again to retrieve the new values.
virtual bool MiExtractorCallback::endPhase | ( | ) | [pure virtual] |
This method is called each time a phase of the current extraction is finished.
virtual bool MiExtractorCallback::endStep | ( | size_t | numIterationDone | ) | [pure virtual] |
This method is called each time a step of the current phase is finished.
This method could be used to update a progress bar.
numIterationDone | total number of iterations done since the phase beginning. To update a progress bar, the percentage of the job done in the current phase is numIterationDone/numIterationInPhase (see beginPhase()) |
virtual double MiExtractorCallback::getEndStepCallPeriod | ( | ) | [pure virtual] |