1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
|
// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-License-Identifier: BSD-3-Clause
/**
* @class vtkSMPProgressObserver
* @brief Progress observer that is thread safe
*
* vtkSMPProgressObserver is designed to handle progress events coming
* from an algorithm in a thread safe way. It does this by using
* thread local objects that it updates. To receive the progress
* information, one has to listen to the local observer in the same
* thread. Since the execution will be somewhat load balanced,
* it may be enough to do this only on the main thread.
*/
#ifndef vtkSMPProgressObserver_h
#define vtkSMPProgressObserver_h
#include "vtkCommonExecutionModelModule.h" // For export macro
#include "vtkProgressObserver.h"
#include "vtkSMPThreadLocalObject.h" // For thread local observers.
VTK_ABI_NAMESPACE_BEGIN
class VTKCOMMONEXECUTIONMODEL_EXPORT vtkSMPProgressObserver : public vtkProgressObserver
{
public:
static vtkSMPProgressObserver* New();
vtkTypeMacro(vtkSMPProgressObserver, vtkProgressObserver);
void PrintSelf(ostream& os, vtkIndent indent) override;
/**
* Passes the progress event to a thread local ProgressObserver
* instance.
*/
void UpdateProgress(double progress) override;
/**
* Returns the progress observer local to the thread it was
* called from.
*/
vtkProgressObserver* GetLocalObserver() { return this->Observers.Local(); }
protected:
vtkSMPProgressObserver();
~vtkSMPProgressObserver() override;
vtkSMPThreadLocalObject<vtkProgressObserver> Observers;
private:
vtkSMPProgressObserver(const vtkSMPProgressObserver&) = delete;
void operator=(const vtkSMPProgressObserver&) = delete;
};
VTK_ABI_NAMESPACE_END
#endif
|
