VTK
vtkXMLCompositeDataReader.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: ParaView
4  Module: vtkXMLCompositeDataReader.h
5 
6  Copyright (c) Kitware, Inc.
7  All rights reserved.
8  See Copyright.txt or http://www.paraview.org/HTML/Copyright.html for details.
9 
10  This software is distributed WITHOUT ANY WARRANTY; without even
11  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
12  PURPOSE. See the above copyright notice for more information.
13 
14 =========================================================================*/
29 #ifndef vtkXMLCompositeDataReader_h
30 #define vtkXMLCompositeDataReader_h
31 
32 #include "vtkIOXMLModule.h" // For export macro
33 #include "vtkXMLReader.h"
34 
38 
39 struct vtkXMLCompositeDataReaderInternals;
40 
41 class VTKIOXML_EXPORT vtkXMLCompositeDataReader : public vtkXMLReader
42 {
43 public:
45  void PrintSelf(ostream& os, vtkIndent indent) override;
46 
47  enum
48  {
50  Interleave
51  };
52 
65  vtkSetClampMacro(PieceDistribution, int, Block, Interleave);
66  vtkGetMacro(PieceDistribution, int);
73  vtkCompositeDataSet* GetOutput();
74  vtkCompositeDataSet* GetOutput(int);
76 
77 protected:
79  ~vtkXMLCompositeDataReader() override;
80 
81  // Get the name of the data set being read.
82  const char* GetDataSetName() override;
83 
84  // Returns the primary element pass to ReadPrimaryElement().
85  vtkXMLDataElement* GetPrimaryElement();
86 
87  void ReadXMLData() override;
88  int ReadPrimaryElement(vtkXMLDataElement* ePrimary) override;
89 
90  // Setup the output with no data available. Used in error cases.
91  void SetupEmptyOutput() override;
92 
93  int FillOutputPortInformation(int, vtkInformation* info) override;
94 
95  // Create a default executive.
97 
98  // Find the path to this file in case the internal files are
99  // specified as relative paths.
100  std::string GetFilePath();
101 
102  std::string GetFileNameFromXML(vtkXMLDataElement* xmlElem, const std::string& filePath);
103 
104  vtkXMLReader* GetReaderOfType(const char* type);
105  vtkXMLReader* GetReaderForFile(const std::string& filename);
106 
108 
109  void SyncDataArraySelections(
110  vtkXMLReader* accum, vtkXMLDataElement* xmlElem, const std::string& filePath);
111 
112  // Adds a child data object to the composite parent. childXML is the XML for
113  // the child data object need to obtain certain meta-data about the child.
114  void AddChild(vtkCompositeDataSet* parent, vtkDataObject* child, vtkXMLDataElement* childXML);
115 
116  // Read the XML element for the subtree of a the composite dataset.
117  // dataSetIndex is used to rank the leaf nodes in an inorder traversal.
118  virtual void ReadComposite(vtkXMLDataElement* element, vtkCompositeDataSet* composite,
119  const char* filePath, unsigned int& dataSetIndex) = 0;
120 
121  // Read the vtkDataSet (a leaf) in the composite dataset.
122  virtual vtkDataSet* ReadDataset(vtkXMLDataElement* xmlElem, const char* filePath);
123 
124  // Read the vtkDataObject (a leaf) in the composite dataset.
125  virtual vtkDataObject* ReadDataObject(vtkXMLDataElement* xmlElem, const char* filePath);
126 
127  // Counts "DataSet" elements in the subtree.
128  unsigned int CountLeaves(vtkXMLDataElement* elem);
129 
134  int ShouldReadDataSet(unsigned int datasetIndex);
135 
136  bool DataSetIsValidForBlockStrategy(unsigned int datasetIndex);
137  bool DataSetIsValidForInterleaveStrategy(unsigned int datasetIndex);
138 
139 private:
141  void operator=(const vtkXMLCompositeDataReader&) = delete;
142 
143  int PieceDistribution;
144 
145  vtkXMLCompositeDataReaderInternals* Internal;
146 };
147 
148 #endif
vtkAlgorithm::CreateDefaultExecutive
virtual vtkExecutive * CreateDefaultExecutive()
Create a default executive.
vtkXMLReader::RequestInformation
virtual int RequestInformation(vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
vtkXMLReader.h
vtkXMLReader::ReadPrimaryElement
virtual int ReadPrimaryElement(vtkXMLDataElement *ePrimary)
vtkX3D::type
Definition: vtkX3D.h:522
vtkInformationVector
Store zero or more vtkInformation instances.
Definition: vtkInformationVector.h:35
tagBlock
Definition: vtkAMRFlashReaderInternal.h:79
vtkCompositeDataSet
abstract superclass for composite (multi-block or AMR) datasets
Definition: vtkCompositeDataSet.h:45
vtkXMLCompositeDataReader::Block
Definition: vtkXMLCompositeDataReader.h:49
vtkExecutive
Superclass for all pipeline executives in VTK.
Definition: vtkExecutive.h:46
vtkXMLCompositeDataReader
Reader for multi-group datasets.
Definition: vtkXMLCompositeDataReader.h:41
vtkXMLReader::ReadXMLData
virtual void ReadXMLData()
vtkInformationIntegerKey
Key for integer values in vtkInformation.
Definition: vtkInformationIntegerKey.h:31
vtkXMLReader::SetupEmptyOutput
virtual void SetupEmptyOutput()=0
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:33
vtkXMLReader::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkXMLReader::GetDataSetName
virtual const char * GetDataSetName()=0
vtkXMLDataElement
Represents an XML element and those nested inside.
Definition: vtkXMLDataElement.h:36
vtkDataSet
abstract class to specify dataset behavior
Definition: vtkDataSet.h:56
vtkInformation
Store vtkAlgorithm input/output information.
Definition: vtkInformation.h:64
vtkX3D::info
Definition: vtkX3D.h:382
vtkX3D::string
Definition: vtkX3D.h:496
vtkInformationIntegerVectorKey
Key for integer vector values.
Definition: vtkInformationIntegerVectorKey.h:31
vtkDataObject
general representation of visualization data
Definition: vtkDataObject.h:58
vtkXMLReader
Superclass for VTK's XML format readers.
Definition: vtkXMLReader.h:43
vtkAlgorithm::FillOutputPortInformation
virtual int FillOutputPortInformation(int port, vtkInformation *info)
Fill the output port information objects for this algorithm.