File: vtkSMTimeKeeperProxy.h

package info (click to toggle)
paraview 5.4.1%2Bdfsg4-3.1
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 218,616 kB
  • sloc: cpp: 2,331,508; ansic: 322,365; python: 111,051; xml: 79,203; tcl: 47,013; yacc: 4,877; java: 4,438; perl: 3,238; sh: 2,920; lex: 1,908; f90: 748; makefile: 273; pascal: 228; objc: 83; fortran: 31
file content (125 lines) | stat: -rw-r--r-- 4,155 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
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
/*=========================================================================

  Program:   ParaView
  Module:    $RCSfile$

  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   vtkSMTimeKeeperProxy
 *
 * We simply pass the TimestepValues and TimeRange properties to the client-side
 * vtkSMTimeKeeper instance so that it can keep those up-to-date.
*/

#ifndef vtkSMTimeKeeperProxy_h
#define vtkSMTimeKeeperProxy_h

#include "vtkPVServerManagerCoreModule.h" //needed for exports
#include "vtkSMProxy.h"

class VTKPVSERVERMANAGERCORE_EXPORT vtkSMTimeKeeperProxy : public vtkSMProxy
{
public:
  static vtkSMTimeKeeperProxy* New();
  vtkTypeMacro(vtkSMTimeKeeperProxy, vtkSMProxy);
  void PrintSelf(ostream& os, vtkIndent indent) VTK_OVERRIDE;

  //@{
  /**
   * Track timesteps provided by a source. If \c suppress_input is true, before
   * adding the proxy, if the \c proxy has producers those will be removed from
   * the time sources i.e. we'll ignore timesteps from the input.
   */
  virtual bool AddTimeSource(vtkSMProxy* proxy, bool suppress_input);
  static bool AddTimeSource(vtkSMProxy* timeKeeper, vtkSMProxy* proxy, bool suppress_input)
  {
    vtkSMTimeKeeperProxy* self = vtkSMTimeKeeperProxy::SafeDownCast(timeKeeper);
    return self ? self->AddTimeSource(proxy, suppress_input) : false;
  }
  //@}

  //@{
  /**
   * Remove a particular time source.
   */
  virtual bool RemoveTimeSource(vtkSMProxy* proxy, bool unsuppress_input);
  static bool RemoveTimeSource(vtkSMProxy* timeKeeper, vtkSMProxy* proxy, bool unsuppress_input)
  {
    vtkSMTimeKeeperProxy* self = vtkSMTimeKeeperProxy::SafeDownCast(timeKeeper);
    return self ? self->RemoveTimeSource(proxy, unsuppress_input) : false;
  }
  //@}

  //@{
  /**
   * Returns true if the proxy has been added to time sources and not
   * suppressed.
   */
  virtual bool IsTimeSourceTracked(vtkSMProxy* proxy);
  static bool IsTimeSourceTracked(vtkSMProxy* timeKeeper, vtkSMProxy* proxy)
  {
    vtkSMTimeKeeperProxy* self = vtkSMTimeKeeperProxy::SafeDownCast(timeKeeper);
    return self ? self->IsTimeSourceTracked(proxy) : false;
  }
  //@}

  //@{
  /**
   * Set whether to suppress a time source that has been added to the time
   * keeper. Suppressing a source results in its time being ignored by the time
   * keeper.
   */
  virtual bool SetSuppressTimeSource(vtkSMProxy* proxy, bool suppress);
  static bool SetSuppressTimeSource(vtkSMProxy* timeKeeper, vtkSMProxy* proxy, bool suppress)
  {
    vtkSMTimeKeeperProxy* self = vtkSMTimeKeeperProxy::SafeDownCast(timeKeeper);
    return self ? self->SetSuppressTimeSource(proxy, suppress) : false;
  }
  //@}

  //@{
  /**
   * Returns a time value after snapping to a lower-bound in the current
   * timesteps.
   */
  virtual double GetLowerBoundTimeStep(double value);
  static double GetLowerBoundTimeStep(vtkSMProxy* timeKeeper, double value)
  {
    vtkSMTimeKeeperProxy* self = vtkSMTimeKeeperProxy::SafeDownCast(timeKeeper);
    return self ? self->GetLowerBoundTimeStep(value) : value;
  }
  //@}

  //@{
  /**
   * Returns the index for the lower bound of the time specified in current
   * timestep values, if possible. If there are no timestep values, returns 0.
   */
  virtual int GetLowerBoundTimeStepIndex(double value);
  static int GetLowerBoundTimeStepIndex(vtkSMProxy* timeKeeper, double value)
  {
    vtkSMTimeKeeperProxy* self = vtkSMTimeKeeperProxy::SafeDownCast(timeKeeper);
    return self ? self->GetLowerBoundTimeStepIndex(value) : 0;
  }
  //@}

protected:
  vtkSMTimeKeeperProxy();
  ~vtkSMTimeKeeperProxy();

  virtual void CreateVTKObjects() VTK_OVERRIDE;

private:
  vtkSMTimeKeeperProxy(const vtkSMTimeKeeperProxy&) VTK_DELETE_FUNCTION;
  void operator=(const vtkSMTimeKeeperProxy&) VTK_DELETE_FUNCTION;
};

#endif