vtkTemporalDataSetCache.h

Go to the documentation of this file.

/*=========================================================================
 
  Program:   Visualization Toolkit
  Module:    vtkTemporalDataSetCache.h
 
  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
  All rights reserved.
  See Copyright.txt or http://www.kitware.com/Copyright.htm 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.
 
=========================================================================*/
#ifndef vtkTemporalDataSetCache_h
#define vtkTemporalDataSetCache_h
 
#include "vtkFiltersHybridModule.h" // For export macro
 
#include "vtkAlgorithm.h"
#include <map>    // used for the cache
#include <vector> // used for the timestep records
 
class VTKFILTERSHYBRID_EXPORT vtkTemporalDataSetCache : public vtkAlgorithm
{
public:
  static vtkTemporalDataSetCache* New();
  vtkTypeMacro(vtkTemporalDataSetCache, vtkAlgorithm);
  void PrintSelf(ostream& os, vtkIndent indent) override;
 
 
  void SetCacheSize(int size);
  vtkGetMacro(CacheSize, int);
 
 
  vtkSetMacro(CacheInMemkind, bool);
  vtkGetMacro(CacheInMemkind, bool);
  vtkBooleanMacro(CacheInMemkind, bool);
 
 
  vtkSetMacro(IsASource, bool);
  vtkGetMacro(IsASource, bool);
  vtkBooleanMacro(IsASource, bool);
 
protected:
  vtkTemporalDataSetCache();
  ~vtkTemporalDataSetCache() override;
 
  int CacheSize;
 
  typedef std::map<double, std::pair<unsigned long, vtkDataObject*>> CacheType;
  CacheType Cache;
  std::vector<double> TimeStepValues;
  vtkTypeBool ProcessRequest(vtkInformation* request, vtkInformationVector** inputVector,
    vtkInformationVector* outputVector) override;
 
  int FillInputPortInformation(int port, vtkInformation* info) override;
  int FillOutputPortInformation(int vtkNotUsed(port), vtkInformation* info) override;
 
  virtual int RequestInformation(
    vtkInformation*, vtkInformationVector** inputVector, vtkInformationVector* outputVector);
 
  virtual int RequestDataObject(
    vtkInformation*, vtkInformationVector** inputVector, vtkInformationVector* outputVector);
 
  virtual int RequestUpdateExtent(vtkInformation*, vtkInformationVector**, vtkInformationVector*);
 
  virtual int RequestData(vtkInformation*, vtkInformationVector**, vtkInformationVector*);
 
private:
  vtkTemporalDataSetCache(const vtkTemporalDataSetCache&) = delete;
  void operator=(const vtkTemporalDataSetCache&) = delete;
 
  void ReplaceCacheItem(vtkDataObject* input, double inTime, vtkMTimeType outputUpdateTime);
  bool CacheInMemkind;
  bool IsASource;
 
  // a helper to deal with eviction smoothly. In effect we are an N+1 cache.
  void SetEjected(vtkDataObject*);
  vtkGetObjectMacro(Ejected, vtkDataObject);
  vtkDataObject* Ejected;
};
 
#endif