VTK-m  2.1
Public Member Functions | Private Attributes | List of all members
vtkm::io::VTKDataSetWriter Class Reference

Reads a legacy VTK file. More...

#include <VTKDataSetWriter.h>

Public Member Functions

 VTKDataSetWriter (const char *fileName)
 
 VTKDataSetWriter (const std::string &fileName)
 Construct a writer to save data to the given file. More...
 
void WriteDataSet (const vtkm::cont::DataSet &dataSet) const
 Write data from the given DataSet object to the file specified in the constructor. More...
 
vtkm::io::FileType GetFileType () const
 Get whether the file will be written in ASCII or binary format. More...
 
void SetFileType (vtkm::io::FileType type)
 Set whether the file will be written in ASCII or binary format. More...
 
void SetFileTypeToAscii ()
 Set whether the file will be written in ASCII or binary format. More...
 
void SetFileTypeToBinary ()
 Set whether the file will be written in ASCII or binary format. More...
 

Private Attributes

std::string FileName
 
vtkm::io::FileType FileType = vtkm::io::FileType::ASCII
 

Detailed Description

Reads a legacy VTK file.

By convention, legacy VTK files have a .vtk extension. This class should be constructed with a filename, and the data read with ReadDataSet.

Constructor & Destructor Documentation

◆ VTKDataSetWriter() [1/2]

vtkm::io::VTKDataSetWriter::VTKDataSetWriter ( const char *  fileName)

◆ VTKDataSetWriter() [2/2]

vtkm::io::VTKDataSetWriter::VTKDataSetWriter ( const std::string &  fileName)

Construct a writer to save data to the given file.

Member Function Documentation

◆ GetFileType()

vtkm::io::FileType vtkm::io::VTKDataSetWriter::GetFileType ( ) const

Get whether the file will be written in ASCII or binary format.

◆ SetFileType()

void vtkm::io::VTKDataSetWriter::SetFileType ( vtkm::io::FileType  type)

Set whether the file will be written in ASCII or binary format.

◆ SetFileTypeToAscii()

void vtkm::io::VTKDataSetWriter::SetFileTypeToAscii ( )
inline

Set whether the file will be written in ASCII or binary format.

◆ SetFileTypeToBinary()

void vtkm::io::VTKDataSetWriter::SetFileTypeToBinary ( )
inline

Set whether the file will be written in ASCII or binary format.

◆ WriteDataSet()

void vtkm::io::VTKDataSetWriter::WriteDataSet ( const vtkm::cont::DataSet dataSet) const

Write data from the given DataSet object to the file specified in the constructor.

Member Data Documentation

◆ FileName

std::string vtkm::io::VTKDataSetWriter::FileName
private

◆ FileType

vtkm::io::FileType vtkm::io::VTKDataSetWriter::FileType = vtkm::io::FileType::ASCII
private

The documentation for this class was generated from the following file: