You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
nmWTAI-Platform/3rd/VTK7.1/include/vtkXMLUniformGridAMRReader.h

130 lines
4.7 KiB
C++

/*=========================================================================
Program: ParaView
Module: vtkXMLUniformGridAMRReader.h
Copyright (c) Kitware, Inc.
All rights reserved.
See Copyright.txt or http://www.paraview.org/HTML/Copyright.html for details.
This software is distributed WITHOUT ANY WARRANTY; without even
the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
PURPOSE. See the above copyright notice for more information.
=========================================================================*/
/**
* @class vtkXMLUniformGridAMRReader
* @brief Reader for amr datasets (vtkOverlappingAMR
* or vtkNonOverlappingAMR).
*
* vtkXMLUniformGridAMRReader reads the VTK XML data files for all types of amr
* datasets including vtkOverlappingAMR, vtkNonOverlappingAMR and the legacy
* vtkHierarchicalBoxDataSet. The reader uses information in the file to
* determine what type of dataset is actually being read and creates the
* output-data object accordingly.
*
* This reader can only read files with version 1.1 or greater.
* Older versions can be converted to the newer versions using
* vtkXMLHierarchicalBoxDataFileConverter.
*/
#ifndef vtkXMLUniformGridAMRReader_h
#define vtkXMLUniformGridAMRReader_h
#include "vtkIOXMLModule.h" // For export macro
#include "vtkXMLCompositeDataReader.h"
#include "vtkSmartPointer.h" // needed for vtkSmartPointer.
class vtkOverlappingAMR;
class vtkUniformGridAMR;
class VTKIOXML_EXPORT vtkXMLUniformGridAMRReader :
public vtkXMLCompositeDataReader
{
public:
static vtkXMLUniformGridAMRReader* New();
vtkTypeMacro(vtkXMLUniformGridAMRReader,vtkXMLCompositeDataReader);
void PrintSelf(ostream& os, vtkIndent indent);
//@{
/**
* This reader supports demand-driven heavy data reading i.e. downstream
* pipeline can request specific blocks from the AMR using
* vtkCompositeDataPipeline::UPDATE_COMPOSITE_INDICES() key in
* RequestUpdateExtent() pass. However, when down-stream doesn't provide any
* specific keys, the default behavior can be setup to read at-most N levels
* by default. The number of levels read can be set using this method.
* Set this to 0 to imply no limit. Default is 0.
*/
vtkSetMacro(MaximumLevelsToReadByDefault, unsigned int);
vtkGetMacro(MaximumLevelsToReadByDefault, unsigned int);
//@}
protected:
vtkXMLUniformGridAMRReader();
~vtkXMLUniformGridAMRReader();
/**
* This method is used by CanReadFile() to check if the reader can read an XML
* with the primary element with the given name. Default implementation
* compares the name with the text returned by this->GetDataSetName().
* Overridden to support all AMR types.
*/
virtual int CanReadFileWithDataType(const char* dsname);
/**
* Read the top-level element from the file. This is always the
* VTKFile element.
* Overridden to read the "type" information specified in the XML. The "type"
* attribute helps us identify the output data type.
*/
virtual int ReadVTKFile(vtkXMLDataElement* eVTKFile);
/**
* Read the meta-data from the AMR from the file. Note that since
* ReadPrimaryElement() is only called when the filename changes, we are
* technically not supporting time-varying AMR datasets in this format right
* now.
*/
virtual int ReadPrimaryElement(vtkXMLDataElement* ePrimary);
/**
* Overridden to create an output data object based on the type in the file.
* Since this reader can handle all subclasses of vtkUniformGrid, we need to
* check in the file to decide what type to create.
*/
virtual int RequestDataObject(vtkInformation *request,
vtkInformationVector **inputVector, vtkInformationVector *outputVector);
/**
* Overridden to put vtkOverlappingAMR in the pipeline if
* available/applicable.
*/
virtual int RequestInformation(vtkInformation *request,
vtkInformationVector **inputVector, vtkInformationVector *outputVector);
// Get the name of the data set being read.
virtual const char* GetDataSetName();
// Read the XML element for the subtree of a the composite dataset.
// dataSetIndex is used to rank the leaf nodes in an inorder traversal.
virtual void ReadComposite(vtkXMLDataElement* element,
vtkCompositeDataSet* composite, const char* filePath,
unsigned int &dataSetIndex);
// Read the vtkDataSet (a leaf) in the composite dataset.
virtual vtkDataSet* ReadDataset(vtkXMLDataElement* xmlElem, const char* filePath);
vtkSmartPointer<vtkOverlappingAMR> Metadata;
unsigned int MaximumLevelsToReadByDefault;
private:
vtkXMLUniformGridAMRReader(const vtkXMLUniformGridAMRReader&) VTK_DELETE_FUNCTION;
void operator=(const vtkXMLUniformGridAMRReader&) VTK_DELETE_FUNCTION;
char* OutputDataType;
vtkSetStringMacro(OutputDataType);
};
#endif