Base class for VTK-XML Writer implementations.

#include <xml.hpp>

Inheritance diagram for GridFormat::VTK::XMLWriterBase< G, Impl >:

Classes
struct	WriteContext

Public Types
using	Grid = G
	Export underlying grid type.

Public Types inherited from GridFormat::GridWriterBase< G >
using	Grid = G

using	Field = typename FieldStorage::Field

using	FieldPtr = typename FieldStorage::FieldPtr

Public Member Functions
	XMLWriterBase (const Grid &grid, std::string extension, bool use_structured_grid_ordering, XMLOptions xml_opts={})

	XMLWriterBase (XMLWriterBase &&)=default

	XMLWriterBase (const XMLWriterBase &)=delete

XMLWriterBase &	operator= (XMLWriterBase &&)=default

XMLWriterBase &	operator= (const XMLWriterBase &)=delete

Impl	with (XMLOptions opts) const

Impl	with_data_format (const XML::DataFormat &format) const

Impl	with_compression (const XML::Compressor &compressor) const

Impl	with_encoding (const XML::Encoder &encoder) const

Impl	with_coordinate_precision (const XML::CoordinatePrecision &prec) const

Impl	with_header_precision (const XML::HeaderPrecision &prec) const

Public Member Functions inherited from GridFormat::GridWriter< G >
	GridWriter (GridWriter &&)=default

	GridWriter (const GridWriter &)=delete

	GridWriter (const G &grid, std::string extension, std::optional< WriterOptions > opts)

GridWriter &	operator= (GridWriter &&)=default

GridWriter &	operator= (const GridWriter &)=delete

std::string	write (const std::string &filename) const

void	write (std::ostream &s) const

const std::string &	extension () const

Public Member Functions inherited from GridFormat::GridWriterBase< G >
	GridWriterBase (const Grid &grid, std::optional< WriterOptions > opts)

template<std::ranges::range R>
void	set_meta_data (const std::string &name, R &&range)

void	set_meta_data (const std::string &name, std::string text)

template<Concepts::Scalar T>
void	set_meta_data (const std::string &name, T value)

template<std::derived_from< Field > F>
void	set_meta_data (const std::string &name, F &&field)

void	set_meta_data (const std::string &name, FieldPtr ptr)

FieldPtr	remove_meta_data (const std::string &name)

template<Concepts::PointFunction< Grid > F, Concepts::Scalar T = GridDetail::PointFunctionScalarType<Grid, F>>
void	set_point_field (const std::string &name, F &&point_function, const Precision< T > &prec={})

template<std::derived_from< Field > F>
void	set_point_field (const std::string &name, F &&field)

void	set_point_field (const std::string &name, FieldPtr field_ptr)

FieldPtr	remove_point_field (const std::string &name)

template<Concepts::CellFunction< Grid > F, Concepts::Scalar T = GridDetail::CellFunctionScalarType<Grid, F>>
void	set_cell_field (const std::string &name, F &&cell_function, const Precision< T > &prec={})

template<std::derived_from< Field > F>
void	set_cell_field (const std::string &name, F &&field)

void	set_cell_field (const std::string &name, FieldPtr field_ptr)

FieldPtr	remove_cell_field (const std::string &name)

void	clear ()

void	set_ignore_warnings (bool value)

const Grid &	grid () const

const std::optional< WriterOptions > &	writer_options () const

template<typename Writer >
void	copy_fields (Writer &w) const

Protected Member Functions
WriteContext	_get_write_context (std::string vtk_grid_type) const

void	_add_meta_data_fields (WriteContext &context) const

template<typename ValueType >
void	_set_attribute (WriteContext &context, std::string_view xml_group, const std::string &attr_name, const ValueType &attr_value) const

void	_set_data_array (WriteContext &context, std::string_view xml_group, std::string data_array_name, const Field &field) const

template<typename DataFormat , typename Appendix , typename Content > requires (!std::is_lvalue_reference_v<Content>)
void	_set_data_array_content (const DataFormat &, XMLElement &e, Appendix &app, Content &&c) const

XMLElement &	_access_at (std::string_view path, WriteContext &context) const

void	_write_xml (WriteContext &&context, std::ostream &s) const

void	_set_default_active_fields (XMLElement &xml) const

Protected Member Functions inherited from GridFormat::GridWriterBase< G >
void	_log_warning (std::string_view warning) const

template<typename EntityFunction , Concepts::Scalar T>
auto	_make_point_field (EntityFunction &&f, const Precision< T > &prec) const

template<typename EntityFunction , Concepts::Scalar T>
auto	_make_cell_field (EntityFunction &&f, const Precision< T > &prec) const

std::ranges::range auto	_point_field_names () const

std::ranges::range auto	_cell_field_names () const

const Field &	_get_point_field (const std::string &name) const

FieldPtr	_get_point_field_ptr (const std::string &name) const

const Field &	_get_cell_field (const std::string &name) const

FieldPtr	_get_cell_field_ptr (const std::string &name) const

std::ranges::range auto	_meta_data_field_names () const

const Field &	_get_meta_data_field (const std::string &name) const

FieldPtr	_get_meta_data_field_ptr (const std::string &name) const

Protected Attributes
XMLOptions	_xml_opts

XMLDetail::XMLSettings	_xml_settings

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

/__w/gridformat/gridformat/gridformat/vtk/xml.hpp

Classes

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes