vtkFileSeriesHelper.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-FileCopyrightText: Copyright (c) Kitware, Inc.
// SPDX-License-Identifier: BSD-3-Clause
#ifndef vtkFileSeriesHelper_h
#define vtkFileSeriesHelper_h
 
#include "vtkObject.h"
 
#include "vtkIOCGNSReaderModule.h" // for export macros
#include "vtkSmartPointer.h"       // for vtkSmartPointer.
#include <string>                  // for std::string
#include <utility>                 // for std::pair
#include <vector>                  // for std::vector
 
VTK_ABI_NAMESPACE_BEGIN
class vtkAlgorithm;
class vtkMultiProcessController;
class vtkInformation;
class vtkMultiProcessStream;
 
class VTKIOCGNSREADER_EXPORT vtkFileSeriesHelper : public vtkObject
{
public:
  static vtkFileSeriesHelper* New();
  vtkTypeMacro(vtkFileSeriesHelper, vtkObject);
  void PrintSelf(ostream& os, vtkIndent indent) override;
 
  typedef bool (*FileNameFunctorType)(vtkAlgorithm* reader, const std::string& filename);
 
 
  void RemoveAllFileNames();
  void AddFileName(const char* fname);
  void SetFileNames(const std::vector<std::string>& filenames);
 
  unsigned int GetNumberOfFiles() const;
 
  virtual bool ReadMetaFile(const char* metafilename);
 
 
  void SetController(vtkMultiProcessController*);
  vtkGetObjectMacro(Controller, vtkMultiProcessController);
 
 
  vtkSetMacro(IgnoreReaderTime, bool);
  vtkGetMacro(IgnoreReaderTime, bool);
  vtkBooleanMacro(IgnoreReaderTime, bool);
 
  virtual bool UpdateInformation(vtkAlgorithm* reader, const FileNameFunctorType& ftor);
 
  vtkGetMacro(UpdateInformationTime, vtkMTimeType);
 
  const std::vector<double>& GetTimeSteps() const { return this->AggregatedTimeSteps; }
 
  const std::pair<double, double>& GetTimeRange(bool* isvalid = nullptr) const
  {
    if (isvalid != nullptr)
    {
      *isvalid = this->AggregatedTimeRangeValid;
    }
    return this->AggregatedTimeRange;
  }
 
  void FillTimeInformation(vtkInformation* info) const;
 
  vtkGetMacro(PartitionedFiles, bool);
 
  std::vector<std::string> GetActiveFiles(vtkInformation* outInfo) const;
 
protected:
  vtkFileSeriesHelper();
  ~vtkFileSeriesHelper() override;
 
  class vtkTimeInformation
  {
  public:
    vtkTimeInformation(vtkInformation* outInfo);
    vtkTimeInformation(double time);
    vtkTimeInformation();
    bool operator==(const vtkTimeInformation& other) const;
 
    const std::pair<double, double>& GetTimeRange() const { return this->TimeRange; }
    const std::vector<double>& GetTimeSteps() const { return this->TimeSteps; }
    bool GetTimeStepsValid() const { return this->TimeStepsValid; }
    bool GetTimeRangeValid() const { return this->TimeRangeValid; }
 
    void Save(vtkMultiProcessStream& stream) const;
    void Load(vtkMultiProcessStream& stream);
 
  private:
    std::pair<double, double> TimeRange;
    std::vector<double> TimeSteps;
    bool TimeRangeValid;
    bool TimeStepsValid;
  };
 
  vtkMultiProcessController* Controller;
  std::vector<std::string> FileNames;
  bool IgnoreReaderTime;
  bool PartitionedFiles;
  std::vector<vtkTimeInformation> Information;
 
private:
  vtkFileSeriesHelper(const vtkFileSeriesHelper&) = delete;
  void operator=(const vtkFileSeriesHelper&) = delete;
 
  std::vector<std::string> SplitFiles(
    const std::vector<std::string>& files, int piece, int numPieces) const;
 
  void Broadcast(int srcRank);
 
  std::vector<double> AggregatedTimeSteps;
  bool AggregatedTimeRangeValid;
  std::pair<double, double> AggregatedTimeRange;
  vtkTimeStamp UpdateInformationTime;
};
 
VTK_ABI_NAMESPACE_END
#endif