vtkMetaReader.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Kitware Inc.
// SPDX-License-Identifier: BSD-3-Clause
 
#ifndef vtkMetaReader_h
#define vtkMetaReader_h
 
#include "vtkDataObjectAlgorithm.h"
#include "vtkPVVTKExtensionsIOCoreModule.h" //needed for exports
 
#include <string> // for std::string
 
class VTKPVVTKEXTENSIONSIOCORE_EXPORT vtkMetaReader : public vtkDataObjectAlgorithm
{
public:
  static vtkMetaReader* New();
  vtkTypeMacro(vtkMetaReader, vtkDataObjectAlgorithm);
 
  vtkMetaReader();
  ~vtkMetaReader() override;
 
 
  vtkSetObjectMacro(Reader, vtkAlgorithm);
  vtkGetObjectMacro(Reader, vtkAlgorithm);
 
 
  void SetMetaFileName(const char* name)
  {
    Set_MetaFileName(name);
    this->MetaFileNameMTime = this->vtkDataObjectAlgorithm::GetMTime();
  }
  char* GetMetaFileName() { return Get_MetaFileName(); }
 
 
  vtkGetVector2Macro(FileIndexRange, vtkIdType);
 
 
  vtkIdType GetFileIndex() { return this->Get_FileIndex(); }
  void SetFileIndex(vtkIdType i)
  {
    this->Set_FileIndex(i);
    this->FileIndexMTime = this->vtkDataObjectAlgorithm::GetMTime();
  }
 
  vtkMTimeType GetMTime() override;
 
 
  vtkSetStringMacro(FileNameMethod);
  vtkGetStringMacro(FileNameMethod);
 
  void PrintSelf(ostream& os, vtkIndent indent) override;
 
protected:
  int FillOutputPortInformation(int port, vtkInformation* info) override;
 
  vtkSetStringMacro(_MetaFileName);
  vtkGetStringMacro(_MetaFileName);
 
  vtkSetMacro(_FileIndex, vtkIdType);
  vtkGetMacro(_FileIndex, vtkIdType);
 
  void ReaderSetFileName(const char* filename);
  int ReaderCanReadFile(const char* filename);
 
  std::string FromRelativeToMetaFile(const char* metaFileName, const char* fileName);
 
  // Reader that handles requests for the meta-reader
  vtkAlgorithm* Reader;
  // Reader modification time after changing the Reader's FileName
  // Used to ignore changing the FileName for the reader when reporting MTime
  vtkMTimeType FileNameMTime;
  // Reader modification time before changing the Reader's FileName
  // Used to ignore changing the FileName for the reader when reporting MTime
  vtkMTimeType BeforeFileNameMTime;
  // Method name used to set the file name for the Reader
  char* FileNameMethod;
  // The index of the file to read.
  vtkIdType _FileIndex;
  vtkMTimeType FileIndexMTime;
  // Range for the file index
  vtkIdType FileIndexRange[2];
 
  // File name for the meta-reader
  char* _MetaFileName;
  // File name modification time
  vtkMTimeType MetaFileNameMTime;
 
  vtkTimeStamp MetaFileReadTime;
 
private:
  vtkMetaReader(const vtkMetaReader&) = delete;
  void operator=(const vtkMetaReader&) = delete;
};
 
#endif