VTK
vtkXMLHyperTreeGridWriter.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkXMLHyperTreeGridWriter.h
5 
6  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
7  All rights reserved.
8  See Copyright.txt or http://www.kitware.com/Copyright.htm 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 =========================================================================*/
26 #ifndef vtkXMLHyperTreeGridWriter_h
27 #define vtkXMLHyperTreeGridWriter_h
28 
29 #include "vtkIOXMLModule.h" // For export macro
30 #include "vtkXMLWriter.h"
31 #include "vtkNew.h" // For ivar
32 
34 class vtkBitArray;
35 class vtkIdTypeArray;
36 class vtkHyperTreeGrid;
38 
39 class VTKIOXML_EXPORT vtkXMLHyperTreeGridWriter : public vtkXMLWriter
40 {
41 public:
43  void PrintSelf(ostream& os, vtkIndent indent) override;
45 
50 
54  const char* GetDefaultFileExtension() override;
55 
56 protected:
59 
60  const char* GetDataSetName() override;
61 
62  // specify that we require HyperTreeGrid input
64 
65  // The most important method, make the XML file for my input.
66  int WriteData() override;
67 
68  // <HyperTreeGrid ...
70 
71  // ... dim, size, origin>
72  void WritePrimaryElementAttributes(ostream &, vtkIndent) override;
73 
74  // Grid coordinates (if origin and scale are not specified)
76 
77  // Tree Structure
79 
80  // Writes PointData and CellData attribute data.
82 
83  // </HyperTreeGrid>
85 
86  // Helper to simplify writing appended array data
88  OffsetsManager &offsets);
89 
91 
94 
97 
99 
100 private:
102  void operator=(const vtkXMLHyperTreeGridWriter&) = delete;
103 };
104 
105 #endif
vtkHyperTreeGridCursor
Objects for depth-first traversal HyperTreeGrids.
Definition: vtkHyperTreeGridCursor.h:46
vtkXMLHyperTreeGridWriter::DescriptorOM
OffsetsManager * DescriptorOM
Definition: vtkXMLHyperTreeGridWriter.h:93
vtkXMLHyperTreeGridWriter::vtkXMLHyperTreeGridWriter
vtkXMLHyperTreeGridWriter()
vtkXMLHyperTreeGridWriter::GetInput
vtkHyperTreeGrid * GetInput()
Get/Set the writer's input.
vtkXMLHyperTreeGridWriter::~vtkXMLHyperTreeGridWriter
~vtkXMLHyperTreeGridWriter() override
vtkXMLHyperTreeGridWriter::MaterialMaskOM
OffsetsManager * MaterialMaskOM
Definition: vtkXMLHyperTreeGridWriter.h:96
vtkXMLHyperTreeGridWriter::FinishPrimaryElement
int FinishPrimaryElement(vtkIndent)
vtkXMLHyperTreeGridWriter::FillInputPortInformation
int FillInputPortInformation(int port, vtkInformation *info) override
Fill the input port information objects for this algorithm.
vtkXMLWriter.h
vtkXMLHyperTreeGridWriter::WriteAppendedArrayDataHelper
void WriteAppendedArrayDataHelper(vtkAbstractArray *array, OffsetsManager &offsets)
vtkXMLHyperTreeGridWriter::WriteGridCoordinates
int WriteGridCoordinates(vtkIndent)
vtkX3D::port
@ port
Definition: vtkX3D.h:447
vtkXMLHyperTreeGridWriter::GetDefaultFileExtension
const char * GetDefaultFileExtension() override
Get the default file extension for files written by this writer.
vtkXMLWriter
Superclass for VTK's XML file writers.
Definition: vtkXMLWriter.h:63
vtkXMLHyperTreeGridWriter::GetDataSetName
const char * GetDataSetName() override
vtkXMLHyperTreeGridWriter::WriteAttributeData
int WriteAttributeData(vtkIndent)
vtkXMLHyperTreeGridWriter::CoordsOMG
OffsetsManagerGroup * CoordsOMG
Definition: vtkXMLHyperTreeGridWriter.h:90
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:40
vtkXMLHyperTreeGridWriter::New
static vtkXMLHyperTreeGridWriter * New()
vtkXMLHyperTreeGridWriter
Write VTK XML HyperTreeGrid files.
Definition: vtkXMLHyperTreeGridWriter.h:40
vtkNew< vtkBitArray >
vtkXMLHyperTreeGridWriter::WritePrimaryElementAttributes
void WritePrimaryElementAttributes(ostream &, vtkIndent) override
OffsetsManagerGroup
Definition: vtkXMLOffsetsManager.h:110
vtkAbstractArray
Abstract superclass for all arrays.
Definition: vtkAbstractArray.h:79
vtkInformation
Store vtkAlgorithm input/output information.
Definition: vtkInformation.h:87
vtkXMLHyperTreeGridWriter::StartPrimaryElement
int StartPrimaryElement(vtkIndent)
vtkX3D::info
@ info
Definition: vtkX3D.h:376
vtkXMLHyperTreeGridWriter::WriteDescriptor
int WriteDescriptor(vtkIndent)
vtkIdTypeArray
dynamic, self-adjusting array of vtkIdType
Definition: vtkIdTypeArray.h:42
vtkNew.h
vtkXMLHyperTreeGridWriter::WriteData
int WriteData() override
vtkXMLHyperTreeGridWriter::Descriptor
vtkNew< vtkBitArray > Descriptor
Definition: vtkXMLHyperTreeGridWriter.h:92
OffsetsManager
Helper class due to PIMPL excess.
Definition: vtkXMLOffsetsManager.h:55
vtkBitArray
dynamic, self-adjusting array of bits
Definition: vtkBitArray.h:37
vtkXMLHyperTreeGridWriter::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkXMLHyperTreeGridWriter::AttributeDataOMG
OffsetsManagerGroup * AttributeDataOMG
Definition: vtkXMLHyperTreeGridWriter.h:98
vtkHyperTreeGrid
A dataset containing a grid of vtkHyperTree instances arranged as a rectilinear grid.
Definition: vtkHyperTreeGrid.h:71
vtkXMLHyperTreeGridWriter::MaterialMask
vtkIdTypeArray * MaterialMask
Definition: vtkXMLHyperTreeGridWriter.h:95