VTK  9.3.0
vtkXMLCompositeDataReader.h
Go to the documentation of this file.
1 // SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
2 // SPDX-FileCopyrightText: Copyright (c) Kitware, Inc.
3 // SPDX-License-Identifier: BSD-3-Clause
30 #ifndef vtkXMLCompositeDataReader_h
31 #define vtkXMLCompositeDataReader_h
32 
33 #include "vtkIOXMLModule.h" // For export macro
34 #include "vtkXMLReader.h"
35 
36 VTK_ABI_NAMESPACE_BEGIN
40 struct vtkXMLCompositeDataReaderInternals;
41 
42 VTK_ABI_NAMESPACE_END
43 #include <set> // for std::set
44 #include <string> // for std::string
45 
46 VTK_ABI_NAMESPACE_BEGIN
47 class VTKIOXML_EXPORT vtkXMLCompositeDataReader : public vtkXMLReader
48 {
49 public:
51  void PrintSelf(ostream& os, vtkIndent indent) override;
52 
53  enum
54  {
56  Interleave
57  };
58 
71  vtkSetClampMacro(PieceDistribution, int, Block, Interleave);
72  vtkGetMacro(PieceDistribution, int);
76 
82 
83  void SetFileName(VTK_FILEPATH const char*) override;
84 
85 protected:
88 
89  // Get the name of the data set being read.
90  const char* GetDataSetName() override;
91 
92  // Returns the primary element pass to ReadPrimaryElement().
94 
95  void ReadXMLData() override;
96  int ReadPrimaryElement(vtkXMLDataElement* ePrimary) override;
97 
98  // Setup the output with no data available. Used in error cases.
99  void SetupEmptyOutput() override;
100 
102 
103  // Create a default executive.
105 
106  // Find the path to this file in case the internal files are
107  // specified as relative paths.
109 
111 
114 
116 
118  vtkXMLReader* accum, vtkXMLDataElement* xmlElem, const std::string& filePath);
119 
120  // Adds a child data object to the composite parent. childXML is the XML for
121  // the child data object need to obtain certain meta-data about the child.
123 
124  // Read the XML element for the subtree of a the composite dataset.
125  // dataSetIndex is used to rank the leaf nodes in an inorder traversal.
126  virtual void ReadComposite(vtkXMLDataElement* element, vtkCompositeDataSet* composite,
127  const char* filePath, unsigned int& dataSetIndex) = 0;
128 
129  // Read the vtkDataSet (a leaf) in the composite dataset.
130  virtual vtkDataSet* ReadDataset(vtkXMLDataElement* xmlElem, const char* filePath);
131 
132  // Read the vtkDataObject (a leaf) in the composite dataset.
133  virtual vtkDataObject* ReadDataObject(vtkXMLDataElement* xmlElem, const char* filePath);
134 
147  unsigned int datasetIndex, unsigned int pieceIndex = 0, unsigned int numPieces = 0);
148 
149 #ifndef __VTK_WRAP__
154  static unsigned int CountNestedElements(vtkXMLDataElement* element, const std::string& tagName,
155  const std::set<std::string>& exclusions = std::set<std::string>());
156 #endif
157 private:
159  void operator=(const vtkXMLCompositeDataReader&) = delete;
160 
162 
167  static int GetPieceAssignmentForBlockStrategy(
168  unsigned int datasetIndex, unsigned int numDatasets, int numPieces);
169  static int GetPieceAssignmentForInterleaveStrategy(
170  unsigned int datasetIndex, unsigned int numDatasets, int numPieces);
172 
173  int PieceDistribution;
174 
175  vtkXMLCompositeDataReaderInternals* Internal;
176 };
177 
178 VTK_ABI_NAMESPACE_END
179 #endif
abstract superclass for composite (multi-block or AMR) datasets
general representation of visualization data
Definition: vtkDataObject.h:64
abstract class to specify dataset behavior
Definition: vtkDataSet.h:62
Superclass for all pipeline executives in VTK.
Definition: vtkExecutive.h:48
a simple class to control print indentation
Definition: vtkIndent.h:38
Key for integer values in vtkInformation.
Store zero or more vtkInformation instances.
Store vtkAlgorithm input/output information.
Reader for multi-group datasets.
void AddChild(vtkCompositeDataSet *parent, vtkDataObject *child, vtkXMLDataElement *childXML)
int FillOutputPortInformation(int, vtkInformation *info) override
Fill the output port information objects for this algorithm.
vtkCompositeDataSet * GetOutput(int)
Get the output data object for a port on this algorithm.
void SetupEmptyOutput() override
Setup the output with no data available.
virtual void ReadComposite(vtkXMLDataElement *element, vtkCompositeDataSet *composite, const char *filePath, unsigned int &dataSetIndex)=0
vtkXMLReader * GetReaderForFile(const std::string &filename)
vtkXMLReader * GetReaderOfType(const char *type)
int ShouldReadDataSet(unsigned int datasetIndex, unsigned int pieceIndex=0, unsigned int numPieces=0)
Given the inorder index for a leaf node, this method tells if the current process should read the dat...
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
const char * GetDataSetName() override
Get the name of the data set being read.
vtkXMLDataElement * GetPrimaryElement()
static unsigned int CountNestedElements(vtkXMLDataElement *element, const std::string &tagName, const std::set< std::string > &exclusions=std::set< std::string >())
Convenience method to count all nested elements with the given tag name.
vtkExecutive * CreateDefaultExecutive() override
Create a default executive.
int RequestInformation(vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
virtual vtkDataSet * ReadDataset(vtkXMLDataElement *xmlElem, const char *filePath)
void ReadXMLData() override
Pipeline execution methods to be defined by subclass.
void SyncDataArraySelections(vtkXMLReader *accum, vtkXMLDataElement *xmlElem, const std::string &filePath)
int ReadPrimaryElement(vtkXMLDataElement *ePrimary) override
Read the primary element from the file.
std::string GetFileNameFromXML(vtkXMLDataElement *xmlElem, const std::string &filePath)
virtual vtkDataObject * ReadDataObject(vtkXMLDataElement *xmlElem, const char *filePath)
vtkCompositeDataSet * GetOutput()
Get the output data object for a port on this algorithm.
~vtkXMLCompositeDataReader() override
void SetFileName(VTK_FILEPATH const char *) override
Represents an XML element and those nested inside.
Superclass for VTK's XML format readers.
Definition: vtkXMLReader.h:48
@ info
Definition: vtkX3D.h:376
@ type
Definition: vtkX3D.h:516
@ string
Definition: vtkX3D.h:490
#define VTK_FILEPATH