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
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
|
/*=========================================================================
Program: ParaView
Module: vtkSMServerStateLocator.h
Copyright (c) Kitware, Inc.
All rights reserved.
See Copyright.txt or http://www.paraview.org/HTML/Copyright.html for details.
This software is distributed WITHOUT ANY WARRANTY; without even
the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
PURPOSE. See the above copyright notice for more information.
=========================================================================*/
/**
* @class vtkSMServerStateLocator
* @brief Class used to retreive a given message state based
* on its GlobalID from the DataServer.
*
* Retreive a given state from the server.
*/
#ifndef vtkSMServerStateLocator_h
#define vtkSMServerStateLocator_h
#include "vtkPVServerManagerCoreModule.h" //needed for exports
#include "vtkSMMessageMinimal.h" // needed for vtkSMMessage.
#include "vtkSMStateLocator.h"
#include "vtkWeakPointer.h" // needed for the session ref
class vtkSMSession;
class VTKPVSERVERMANAGERCORE_EXPORT vtkSMServerStateLocator : public vtkSMStateLocator
{
public:
static vtkSMServerStateLocator* New();
vtkTypeMacro(vtkSMServerStateLocator, vtkSMStateLocator);
void PrintSelf(ostream& os, vtkIndent indent) VTK_OVERRIDE;
//@{
/**
* Set/Get a parent locator to search which is used as a backup location
* to search from if a given state was not found locally.
*/
vtkSMSession* GetSession();
void SetSession(vtkSMSession* session);
//@}
/**
* Fill the provided State message with the state found inside the current
* locator or one of its parent. The method return true if the state was
* successfully filled.
* In that case useParent is not used and is set to false.
*/
virtual bool FindState(
vtkTypeUInt32 globalID, vtkSMMessage* stateToFill, bool useParent) VTK_OVERRIDE;
protected:
vtkSMServerStateLocator();
~vtkSMServerStateLocator();
vtkWeakPointer<vtkSMSession> Session;
private:
vtkSMServerStateLocator(const vtkSMServerStateLocator&) VTK_DELETE_FUNCTION;
void operator=(const vtkSMServerStateLocator&) VTK_DELETE_FUNCTION;
};
#endif
|
