File: vtkSession.h

package info (click to toggle)
paraview 5.1.2%2Bdfsg1-2
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 221,108 kB
  • ctags: 236,092
  • sloc: cpp: 2,416,026; ansic: 190,891; python: 99,856; xml: 81,001; tcl: 46,915; yacc: 5,039; java: 4,413; perl: 3,108; sh: 1,974; lex: 1,926; f90: 748; asm: 471; pascal: 228; makefile: 198; objc: 83; fortran: 31
file content (64 lines) | stat: -rw-r--r-- 2,135 bytes parent folder | download
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
/*=========================================================================

  Program:   ParaView
  Module:    vtkSession.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.

=========================================================================*/
// .NAME vtkSession
// .SECTION Description
// vtkSession defines a session i.e. a conversation, if you will. It can be
// between different processes or same process. What types of conversations are
// possible i.e what protocols are supported, is defined by the subclasses.

#ifndef vtkSession_h
#define vtkSession_h

#include "vtkPVClientServerCoreCoreModule.h" //needed for exports
#include "vtkObject.h"

class VTKPVCLIENTSERVERCORECORE_EXPORT vtkSession : public vtkObject
{
public:
  vtkTypeMacro(vtkSession, vtkObject);
  void PrintSelf(ostream& os, vtkIndent indent);

  // Description:
  // Returns true is this session is active/alive/valid.
  virtual bool GetIsAlive() = 0;

protected:
  vtkSession();
  ~vtkSession();

  // Needed when TileDisplay are retreived
  friend class vtkSMRenderViewProxy;
  // Need to manually active the session
  friend class vtkPVServerSideAnimationPlayer;

  // Description:
  // Subclasses must call this to mark the session active. This sets the active
  // session pointer held by the vtkProcessModule, making it easier for filters
  // etc. that need information about the active session to access it.
  virtual void Activate();

  // Description:
  // Subclasses must call this to mark the session inactive. This sets the active
  // session pointer held by the vtkProcessModule, making it easier for filters
  // etc. that need information about the active session to access it.
  virtual void DeActivate();

private:
  vtkSession(const vtkSession&); // Not implemented
  void operator=(const vtkSession&); // Not implemented

};

#endif