Tatooine
Public Member Functions | Private Attributes | List of all members
tatooine::vtk::xml::reader Struct Reference

#include <reader.h>

Collaboration diagram for tatooine::vtk::xml::reader:
[legend]

Public Member Functions

auto type () const
 
auto byte_order () const
 
auto version () const -> auto const &
 
auto image_data () const -> auto const &
 
auto rectilinear_grid () const -> auto const &
 
auto structured_grid () const -> auto const &
 
auto poly_data () const -> auto const &
 
auto unstructured_grid () const -> auto const &
 
auto file () const -> auto const &
 
auto file () -> auto &
 
auto xml_document () const -> auto const &
 
auto xml_document () -> auto &
 
auto read_appended_data_size (std::size_t offset) const -> std::size_t
 Returns number of bytes of the following data block. More...
 
auto read_appended_data (char *data, std::size_t num_bytes, std::size_t offset) const -> void
 
 reader (filesystem::path const &path)
 
 ~reader ()
 
auto extract_appended_data (std::string &content) -> void
 
auto read_meta () -> void
 

Private Attributes

vtk_type m_type = vtk_type::unknown
 
xml::byte_order m_byte_order = byte_order::unknown
 
xml::data_type m_header_type = data_type::unknown
 
std::string m_version = ""
 
filesystem::path m_path = {}
 
std::ifstream m_file
 
rapidxml::xml_document m_doc
 
std::size_t m_begin_appended_data = {}
 
std::optional< xml::image_datam_image_data
 
std::optional< xml::rectilinear_gridm_rectilinear_grid
 
std::optional< xml::structured_gridm_structured_grid
 
std::optional< xml::poly_datam_poly_data
 
std::optional< xml::unstructured_gridm_unstructured_grid
 

Constructor & Destructor Documentation

◆ reader()

tatooine::vtk::xml::reader::reader ( filesystem::path const &  path)

◆ ~reader()

tatooine::vtk::xml::reader::~reader ( )
inline

Member Function Documentation

◆ byte_order()

◆ extract_appended_data()

auto tatooine::vtk::xml::reader::extract_appended_data ( std::string &  content) -> void

The binary appended data part needs to be extracted in order to make rapidxml read the file.

◆ file() [1/2]

auto tatooine::vtk::xml::reader::file ( ) -> auto&
inline

◆ file() [2/2]

auto tatooine::vtk::xml::reader::file ( ) const -> auto const&
inline

◆ image_data()

auto tatooine::vtk::xml::reader::image_data ( ) const -> auto const&
inline

◆ poly_data()

auto tatooine::vtk::xml::reader::poly_data ( ) const -> auto const&
inline

◆ read_appended_data()

auto tatooine::vtk::xml::reader::read_appended_data ( char *  data,
std::size_t  num_bytes,
std::size_t  offset 
) const -> void

Reads the data block that follows the size of the actual data block. num_bytes needs to be retrieved from read_appended_data_size method.

◆ read_appended_data_size()

auto tatooine::vtk::xml::reader::read_appended_data_size ( std::size_t  offset) const -> std::size_t

Returns number of bytes of the following data block.

◆ read_meta()

auto tatooine::vtk::xml::reader::read_meta ( ) -> void

◆ rectilinear_grid()

auto tatooine::vtk::xml::reader::rectilinear_grid ( ) const -> auto const&
inline

◆ structured_grid()

auto tatooine::vtk::xml::reader::structured_grid ( ) const -> auto const&
inline

◆ type()

auto tatooine::vtk::xml::reader::type ( ) const
inline

◆ unstructured_grid()

auto tatooine::vtk::xml::reader::unstructured_grid ( ) const -> auto const&
inline

◆ version()

auto tatooine::vtk::xml::reader::version ( ) const -> auto const&
inline

◆ xml_document() [1/2]

auto tatooine::vtk::xml::reader::xml_document ( ) -> auto&
inline

◆ xml_document() [2/2]

auto tatooine::vtk::xml::reader::xml_document ( ) const -> auto const&
inline

Member Data Documentation

◆ m_begin_appended_data

std::size_t tatooine::vtk::xml::reader::m_begin_appended_data = {}
private

◆ m_byte_order

xml::byte_order tatooine::vtk::xml::reader::m_byte_order = byte_order::unknown
private

◆ m_doc

rapidxml::xml_document tatooine::vtk::xml::reader::m_doc
private

◆ m_file

std::ifstream tatooine::vtk::xml::reader::m_file
mutableprivate

◆ m_header_type

xml::data_type tatooine::vtk::xml::reader::m_header_type = data_type::unknown
private

◆ m_image_data

std::optional<xml::image_data> tatooine::vtk::xml::reader::m_image_data
private

◆ m_path

filesystem::path tatooine::vtk::xml::reader::m_path = {}
private

◆ m_poly_data

std::optional<xml::poly_data> tatooine::vtk::xml::reader::m_poly_data
private

◆ m_rectilinear_grid

std::optional<xml::rectilinear_grid> tatooine::vtk::xml::reader::m_rectilinear_grid
private

◆ m_structured_grid

std::optional<xml::structured_grid> tatooine::vtk::xml::reader::m_structured_grid
private

◆ m_type

vtk_type tatooine::vtk::xml::reader::m_type = vtk_type::unknown
private

◆ m_unstructured_grid

std::optional<xml::unstructured_grid> tatooine::vtk::xml::reader::m_unstructured_grid
private

◆ m_version

std::string tatooine::vtk::xml::reader::m_version = ""
private

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