VTK
dox
Common
ExecutionModel
vtkSMPProgressObserver.h
Go to the documentation of this file.
1
/*=========================================================================
2
3
Program: Visualization Toolkit
4
Module: vtkSMPProgressObserver.h
5
6
Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
7
All rights reserved.
8
See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
9
10
This software is distributed WITHOUT ANY WARRANTY; without even
11
the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
12
PURPOSE. See the above copyright notice for more information.
13
14
=========================================================================*/
27
#ifndef vtkSMPProgressObserver_h
28
#define vtkSMPProgressObserver_h
29
30
#include "vtkCommonExecutionModelModule.h"
// For export macro
31
#include "
vtkProgressObserver.h
"
32
#include "
vtkSMPThreadLocalObject.h
"
// For thread local observers.
33
34
class
VTKCOMMONEXECUTIONMODEL_EXPORT
vtkSMPProgressObserver
:
public
vtkProgressObserver
35
{
36
public
:
37
static
vtkSMPProgressObserver
*
New
();
38
vtkTypeMacro(
vtkSMPProgressObserver
,
vtkProgressObserver
);
39
void
PrintSelf
(ostream& os,
vtkIndent
indent)
override
;
40
45
void
UpdateProgress
(
double
amount)
override
;
46
51
vtkProgressObserver
*
GetLocalObserver
()
52
{
53
return
this->Observers.Local();
54
}
55
56
protected
:
57
vtkSMPProgressObserver
();
58
~
vtkSMPProgressObserver
()
override
;
59
60
vtkSMPThreadLocalObject<vtkProgressObserver>
Observers
;
61
62
private
:
63
vtkSMPProgressObserver
(
const
vtkSMPProgressObserver
&) =
delete
;
64
void
operator=(
const
vtkSMPProgressObserver
&) =
delete
;
65
};
66
67
#endif
vtkSMPThreadLocalObject.h
vtkProgressObserver.h
vtkSMPProgressObserver
Progress observer that is thread safe.
Definition:
vtkSMPProgressObserver.h:34
vtkSMPProgressObserver::GetLocalObserver
vtkProgressObserver * GetLocalObserver()
Returns the progress observer local to the thread it was called from.
Definition:
vtkSMPProgressObserver.h:51
vtkSMPProgressObserver::Observers
vtkSMPThreadLocalObject< vtkProgressObserver > Observers
Definition:
vtkSMPProgressObserver.h:60
vtkSMPThreadLocalObject< vtkProgressObserver >
vtkProgressObserver::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkIndent
a simple class to control print indentation
Definition:
vtkIndent.h:39
vtkProgressObserver::New
static vtkProgressObserver * New()
vtkProgressObserver
Basic class to optionally replace vtkAlgorithm progress functionality.
Definition:
vtkProgressObserver.h:36
vtkProgressObserver::UpdateProgress
virtual void UpdateProgress(double amount)
The default behavior is to update the Progress data member and invoke a ProgressEvent.
Generated by
1.8.16