vtkXMLCollectionReader.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Kitware Inc.
// SPDX-License-Identifier: BSD-3-Clause
#ifndef vtkXMLCollectionReader_h
#define vtkXMLCollectionReader_h
 
#include "vtkPVVTKExtensionsIOCoreModule.h" //needed for exports
#include "vtkXMLReader.h"
 
class vtkXMLCollectionReaderInternals;
 
class VTKPVVTKEXTENSIONSIOCORE_EXPORT vtkXMLCollectionReader : public vtkXMLReader
{
public:
  static vtkXMLCollectionReader* New();
  vtkTypeMacro(vtkXMLCollectionReader, vtkXMLReader);
  void PrintSelf(ostream& os, vtkIndent indent) override;
 
 
  virtual void SetRestriction(const char* name, const char* value);
  virtual const char* GetRestriction(const char* name);
 
 
  virtual void SetRestrictionAsIndex(const char* name, int index);
  virtual int GetRestrictionAsIndex(const char* name);
 
  int GetNumberOfAttributes();
 
  const char* GetAttributeName(int attribute);
 
  int GetAttributeIndex(const char* name);
 
  int GetNumberOfAttributeValues(int attribute);
 
 
  const char* GetAttributeValue(int attribute, int index);
  const char* GetAttributeValue(const char* name, int index);
 
 
  int GetAttributeValueIndex(int attribute, const char* value);
  int GetAttributeValueIndex(const char* name, const char* value);
 
  vtkXMLDataElement* GetOutputXMLDataElement(int index);
 
 
  vtkSetMacro(ForceOutputTypeToMultiBlock, int);
  vtkGetMacro(ForceOutputTypeToMultiBlock, int);
  vtkBooleanMacro(ForceOutputTypeToMultiBlock, int);
 
protected:
  vtkXMLCollectionReader();
  ~vtkXMLCollectionReader() override;
 
  void BuildRestrictedDataSets();
 
  bool InternalForceMultiBlock;
  int ForceOutputTypeToMultiBlock;
 
  // Get the name of the data set being read.
  const char* GetDataSetName() override;
 
  int ReadPrimaryElement(vtkXMLDataElement* ePrimary) override;
  int FillOutputPortInformation(int, vtkInformation* info) override;
 
  vtkDataObject* SetupOutput(const std::string& filePath, int index);
 
  vtkXMLReader* SetupReader(const std::string& filePath, int index);
 
  int RequestDataObject(vtkInformation* request, vtkInformationVector** inputVector,
    vtkInformationVector* outputVector) override;
 
  // Overload of vtkXMLReader function, so we can handle updating the
  // information on multiple outputs
  int RequestInformation(vtkInformation* request, vtkInformationVector** inputVector,
    vtkInformationVector* outputVector) override;
 
  // Setup the output with no data available.  Used in error cases.
  void SetupEmptyOutput() override;
 
  void ReadXMLData() override;
  void ReadXMLDataImpl();
 
  // Progress callback from XMLParser.
  virtual void InternalProgressCallback();
 
  // Internal implementation details.
  vtkXMLCollectionReaderInternals* Internal;
 
  void AddAttributeNameValue(const char* name, const char* value);
 
  virtual void SetRestrictionImpl(const char* name, const char* value, bool doModify);
 
  void ReadAFile(int index, int updatePiece, int updateNumPieces, int updateGhostLevels,
    vtkDataObject* actualOutput);
 
  void FillArraySelectionUsingReaders(const std::string& filePath);
 
private:
  vtkXMLCollectionReader(const vtkXMLCollectionReader&) = delete;
  void operator=(const vtkXMLCollectionReader&) = delete;
 
  int CurrentOutput;
};
 
#endif