VTK  9.1.0
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
38struct vtkXMLCompositeDataReaderInternals;
39
40#include <set> // for std::set
41#include <string> // for std::string
42
43class VTKIOXML_EXPORT vtkXMLCompositeDataReader : public vtkXMLReader
44{
45public:
47 void PrintSelf(ostream& os, vtkIndent indent) override;
48
49 enum
50 {
52 Interleave
53 };
54
67 vtkSetClampMacro(PieceDistribution, int, Block, Interleave);
68 vtkGetMacro(PieceDistribution, int);
72
78
79 void SetFileName(VTK_FILEPATH const char*) override;
80
81protected:
84
85 // Get the name of the data set being read.
86 const char* GetDataSetName() override;
87
88 // Returns the primary element pass to ReadPrimaryElement().
90
91 void ReadXMLData() override;
92 int ReadPrimaryElement(vtkXMLDataElement* ePrimary) override;
93
94 // Setup the output with no data available. Used in error cases.
95 void SetupEmptyOutput() override;
96
98
99 // Create a default executive.
101
102 // Find the path to this file in case the internal files are
103 // specified as relative paths.
105
107
110
112
114 vtkXMLReader* accum, vtkXMLDataElement* xmlElem, const std::string& filePath);
115
116 // Adds a child data object to the composite parent. childXML is the XML for
117 // the child data object need to obtain certain meta-data about the child.
119
120 // Read the XML element for the subtree of a the composite dataset.
121 // dataSetIndex is used to rank the leaf nodes in an inorder traversal.
122 virtual void ReadComposite(vtkXMLDataElement* element, vtkCompositeDataSet* composite,
123 const char* filePath, unsigned int& dataSetIndex) = 0;
124
125 // Read the vtkDataSet (a leaf) in the composite dataset.
126 virtual vtkDataSet* ReadDataset(vtkXMLDataElement* xmlElem, const char* filePath);
127
128 // Read the vtkDataObject (a leaf) in the composite dataset.
129 virtual vtkDataObject* ReadDataObject(vtkXMLDataElement* xmlElem, const char* filePath);
130
143 unsigned int datasetIndex, unsigned int pieceIndex = 0, unsigned int numPieces = 0);
144
145#ifndef __VTK_WRAP__
150 static unsigned int CountNestedElements(vtkXMLDataElement* element, const std::string& tagName,
151 const std::set<std::string>& exclusions = std::set<std::string>());
152#endif
153private:
155 void operator=(const vtkXMLCompositeDataReader&) = delete;
156
158
163 static int GetPieceAssignmentForBlockStrategy(
164 unsigned int datasetIndex, unsigned int numDatasets, int numPieces);
165 static int GetPieceAssignmentForInterleaveStrategy(
166 unsigned int datasetIndex, unsigned int numDatasets, int numPieces);
168
169 int PieceDistribution;
170
171 vtkXMLCompositeDataReaderInternals* Internal;
172};
173
174#endif
abstract superclass for composite (multi-block or AMR) datasets
general representation of visualization data
Definition: vtkDataObject.h:60
abstract class to specify dataset behavior
Definition: vtkDataSet.h:57
Superclass for all pipeline executives in VTK.
Definition: vtkExecutive.h:47
a simple class to control print indentation
Definition: vtkIndent.h:34
Key for integer values in vtkInformation.
Store zero or more vtkInformation instances.
Store vtkAlgorithm input/output information.
Reader for multi-group datasets.
vtkXMLDataElement * GetPrimaryElement()
vtkCompositeDataSet * GetOutput(int)
Get the output data object for a port on this algorithm.
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()
Get the output data object for a port on this algorithm.
void SetupEmptyOutput() override
virtual void ReadComposite(vtkXMLDataElement *element, vtkCompositeDataSet *composite, const char *filePath, unsigned int &dataSetIndex)=0
virtual vtkDataObject * ReadDataObject(vtkXMLDataElement *xmlElem, const char *filePath)
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.
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.
int RequestInformation(vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
virtual vtkDataSet * ReadDataset(vtkXMLDataElement *xmlElem, const char *filePath)
const char * GetDataSetName() override
void ReadXMLData() override
void SyncDataArraySelections(vtkXMLReader *accum, vtkXMLDataElement *xmlElem, const std::string &filePath)
int ReadPrimaryElement(vtkXMLDataElement *ePrimary) override
std::string GetFileNameFromXML(vtkXMLDataElement *xmlElem, const std::string &filePath)
vtkXMLReader * GetReaderOfType(const char *type)
vtkExecutive * CreateDefaultExecutive() override
Create a default executive.
vtkXMLReader * GetReaderForFile(const std::string &filename)
~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:47
@ info
Definition: vtkX3D.h:382
@ type
Definition: vtkX3D.h:522
@ string
Definition: vtkX3D.h:496
#define VTK_FILEPATH