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 =========================================================================*/
23 #ifndef vtkXMLHyperTreeGridWriter_h
24 #define vtkXMLHyperTreeGridWriter_h
25 
26 #include "vtkIOXMLModule.h" // For export macro
27 #include "vtkXMLWriter.h"
28 #include "vtkNew.h" // For ivar
29 
31 class vtkBitArray;
32 class vtkIdTypeArray;
33 class vtkHyperTreeGrid;
35 
36 class VTKIOXML_EXPORT vtkXMLHyperTreeGridWriter : public vtkXMLWriter
37 {
38 public:
40  void PrintSelf(ostream& os, vtkIndent indent) override;
42 
47 
51  const char* GetDefaultFileExtension() override;
52 
53 protected:
55  ~vtkXMLHyperTreeGridWriter() override;
56 
57  const char* GetDataSetName() override;
58 
59  // specify that we require HyperTreeGrid input
61 
62  // The most important method, make the XML file for my input.
63  int WriteData() override;
64 
65  // <HyperTreeGrid ...
66  int StartPrimaryElement(vtkIndent);
67 
68  // ... dim, size, origin>
69  void WritePrimaryElementAttributes(ostream &, vtkIndent) override;
70 
71  // Grid coordinates (if origin and scale are not specified)
72  int WriteGridCoordinates(vtkIndent);
73 
74  // Tree Structure
75  int WriteDescriptor(vtkIndent);
76 
77  // Writes PointData and CellData attribute data.
78  int WriteAttributeData(vtkIndent);
79 
80  // </HyperTreeGrid>
81  int FinishPrimaryElement(vtkIndent);
82 
83  // Helper to simplify writing appended array data
84  void WriteAppendedArrayDataHelper(vtkAbstractArray *array,
85  OffsetsManager &offsets);
86 
88 
91 
94 
96 
97 private:
99  void operator=(const vtkXMLHyperTreeGridWriter&) = delete;
100 };
101 
102 #endif
vtkHyperTreeGridCursor
Objects for depth-first traversal HyperTreeGrids.
Definition: vtkHyperTreeGridCursor.h:45
vtkXMLHyperTreeGridWriter::DescriptorOM
OffsetsManager * DescriptorOM
Definition: vtkXMLHyperTreeGridWriter.h:90
vtkXMLWriter::GetDefaultFileExtension
virtual const char * GetDefaultFileExtension()=0
Get the default file extension for files written by this writer.
vtkXMLWriter::WritePrimaryElementAttributes
virtual void WritePrimaryElementAttributes(ostream &os, vtkIndent indent)
vtkAlgorithm::FillInputPortInformation
virtual int FillInputPortInformation(int port, vtkInformation *info)
Fill the input port information objects for this algorithm.
vtkXMLHyperTreeGridWriter::MaterialMaskOM
OffsetsManager * MaterialMaskOM
Definition: vtkXMLHyperTreeGridWriter.h:93
vtkXMLWriter.h
vtkX3D::port
Definition: vtkX3D.h:447
vtkXMLWriter
Superclass for VTK's XML file writers.
Definition: vtkXMLWriter.h:59
vtkXMLHyperTreeGridWriter::CoordsOMG
OffsetsManagerGroup * CoordsOMG
Definition: vtkXMLHyperTreeGridWriter.h:87
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:33
vtkXMLWriter::GetDataSetName
virtual const char * GetDataSetName()=0
vtkXMLHyperTreeGridWriter
Write VTK XML HyperTreeGrid files.
Definition: vtkXMLHyperTreeGridWriter.h:36
vtkNew< vtkBitArray >
vtkXMLWriter::WriteData
virtual int WriteData()
Definition: vtkXMLWriter.h:357
OffsetsManagerGroup
Definition: vtkXMLOffsetsManager.h:109
vtkXMLWriter::GetInput
vtkDataObject * GetInput()
Definition: vtkXMLWriter.h:232
vtkAbstractArray
Abstract superclass for all arrays.
Definition: vtkAbstractArray.h:75
vtkInformation
Store vtkAlgorithm input/output information.
Definition: vtkInformation.h:80
vtkX3D::info
Definition: vtkX3D.h:376
vtkAlgorithm::New
static vtkAlgorithm * New()
vtkIdTypeArray
dynamic, self-adjusting array of vtkIdType
Definition: vtkIdTypeArray.h:35
vtkNew.h
vtkXMLHyperTreeGridWriter::Descriptor
vtkNew< vtkBitArray > Descriptor
Definition: vtkXMLHyperTreeGridWriter.h:89
OffsetsManager
Helper class due to PIMPL excess.
Definition: vtkXMLOffsetsManager.h:54
vtkBitArray
dynamic, self-adjusting array of bits
Definition: vtkBitArray.h:33
vtkXMLHyperTreeGridWriter::AttributeDataOMG
OffsetsManagerGroup * AttributeDataOMG
Definition: vtkXMLHyperTreeGridWriter.h:95
vtkXMLWriter::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkHyperTreeGrid
A dataset containing a grid of vtkHyperTree instances arranged as a rectilinear grid.
Definition: vtkHyperTreeGrid.h:67
vtkXMLHyperTreeGridWriter::MaterialMask
vtkIdTypeArray * MaterialMask
Definition: vtkXMLHyperTreeGridWriter.h:92