Inviwo 0.9.12-pre
Inviwo documentation
Loading...
Searching...
No Matches
inviwo::DataWriterType< Layer > Class Template Referenceabstract

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
 
DataWriterTypeoperator= (const DataWriterType &that)=default
 
 DataWriterType (DataWriterType &&rhs) noexcept=default
 
DataWriterTypeoperator= (DataWriterType &&that) noexcept=default
 
virtual DataWriterTypeclone () 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)
 
DataWriteroperator= (const DataWriter &that)
 
 DataWriter (DataWriter &&rhs) noexcept=default
 
DataWriteroperator= (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.
 

Additional Inherited Members

- Static Public Member Functions inherited from inviwo::DataWriter
static void checkOverwrite (const std::filesystem::path &path, Overwrite overwrite)
 
- 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
 
- Protected Attributes inherited from inviwo::DataWriter
Overwrite overwrite_
 
std::vector< FileExtensionextensions_
 

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

◆ clone()

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

Implements inviwo::DataWriter.

◆ writeData()

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
DataWriterExceptionif anything goes wrong

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