Template base class for file writers designating what type of data object the writer writes. More...

#include <datawriter.h>

Inheritance diagram for inviwo::DataWriterType< Layer >:

Public Member Functions
	DataWriterType (const DataWriterType &rhs)=default

DataWriterType &	operator= (const DataWriterType &that)=default

	DataWriterType (DataWriterType &&rhs) noexcept=default

DataWriterType &	operator= (DataWriterType &&that) noexcept=default

virtual DataWriterType *	clone () const override=0

virtual void	writeData (const T *data, const std::filesystem::path &filePath) const =0
	Write `data` to `filePath`.

virtual std::unique_ptr< std::vector< unsigned char > >	writeDataToBuffer (const T *, std::string_view) const

Public Member Functions inherited from inviwo::DataWriter
	DataWriter (const DataWriter &rhs)

DataWriter &	operator= (const DataWriter &that)

	DataWriter (DataWriter &&rhs) noexcept=default

DataWriter &	operator= (DataWriter &&that) noexcept=default

const std::vector< FileExtension > &	getExtensions () const

void	addExtension (FileExtension ext)

Overwrite	getOverwrite () const

void	setOverwrite (Overwrite val)

void	checkOverwrite (const std::filesystem::path &path) const

virtual bool	setOption (std::string_view key, std::any value)
	Set writer specific options See the documentation of the specific writer for the available options.

virtual std::any	getOption (std::string_view key) const
	Query the value of a writer specific option.

template<typename T >
bool	writesType () const

Protected Member Functions
virtual bool	canWrite (const std::type_index &index) const override

Protected Member Functions inherited from inviwo::DataWriter
std::ofstream	open (const std::filesystem::path &path, std::ios_base::openmode mode=std::ios_base::out) const

Additional Inherited Members
Static Public Member Functions inherited from inviwo::DataWriter
static void	checkOverwrite (const std::filesystem::path &path, Overwrite overwrite)

Protected Attributes inherited from inviwo::DataWriter
Overwrite	overwrite_

std::vector< FileExtension >	extensions_

Detailed Description

template<class Layer>
class inviwo::DataWriterType< Layer >

Template base class for file writers designating what type of data object the writer writes.

Member Function Documentation

template<class Layer >

virtual bool inviwo::DataWriterType< Layer >::canWrite ( const std::type_index & index ) const

inlineoverrideprotectedvirtual

template<class Layer >

virtual DataWriterType * inviwo::DataWriterType< Layer >::clone ( ) const

overridepure virtual

template<class Layer >

virtual void inviwo::DataWriterType< Layer >::writeData	(	const T *	data,
		const std::filesystem::path &	filePath ) const

pure virtual

Write data to filePath.

Exceptions

DataWriterException if anything goes wrong

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