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

Template base class for file readers designating what type of data object the reader returns. More...

#include <datareader.h>

+ Inheritance diagram for inviwo::DataReaderType< T >:

Public Member Functions

 DataReaderType (const DataReaderType &rhs)=default
 
 DataReaderType (DataReaderType &&rhs) noexcept=default
 
DataReaderTypeoperator= (const DataReaderType &that)=default
 
DataReaderTypeoperator= (DataReaderType &&that) noexcept=default
 
virtual DataReaderTypeclone () const override=0
 
virtual std::shared_ptr< T > readData (const std::filesystem::path &filePath)=0
 
virtual std::shared_ptr< T > readData (const std::filesystem::path &filePath, MetaDataOwner *)
 
- Public Member Functions inherited from inviwo::DataReader
 DataReader (const DataReader &rhs)=default
 
 DataReader (DataReader &&rhs) noexcept=default
 
DataReaderoperator= (const DataReader &that)=default
 
DataReaderoperator= (DataReader &&that) noexcept=default
 
const std::vector< FileExtension > & getExtensions () const
 
void addExtension (FileExtension ext)
 
virtual bool setOption (std::string_view key, std::any value)
 Set reader specific options See the documentation of the specific reader for the available options.
 
virtual std::any getOption (std::string_view key)
 Query the value of an reader specific option.
 
template<typename T >
bool readsType () const
 

Protected Member Functions

virtual bool canRead (const std::type_index &index) const override
 
- Protected Member Functions inherited from inviwo::DataReader
void checkExists (const std::filesystem::path &path) const
 
std::ifstream open (const std::filesystem::path &path, std::ios_base::openmode mode=std::ios_base::in) const
 

Additional Inherited Members

- Protected Attributes inherited from inviwo::DataReader
std::vector< FileExtensionextensions_
 

Detailed Description

template<typename T>
class inviwo::DataReaderType< T >

Template base class for file readers designating what type of data object the reader returns.

Member Function Documentation

◆ canRead()

template<typename T >
virtual bool inviwo::DataReaderType< T >::canRead ( const std::type_index & index) const
inlineoverrideprotectedvirtual

Implements inviwo::DataReader.

◆ clone()

template<typename T >
virtual DataReaderType * inviwo::DataReaderType< T >::clone ( ) const
overridepure virtual

Implements inviwo::DataReader.

◆ readData() [1/2]

template<typename T >
virtual std::shared_ptr< T > inviwo::DataReaderType< T >::readData ( const std::filesystem::path & filePath)
pure virtual

◆ readData() [2/2]

template<typename T >
virtual std::shared_ptr< T > inviwo::DataReaderType< T >::readData ( const std::filesystem::path & filePath,
MetaDataOwner *  )
inlinevirtual

Optional overload that passed a MetaDataOwner to facilitate saving/loading state in the data reader the use is optional and the pointer can be null.

See also
RawVolumeReader

Reimplemented in inviwo::RawVolumeReader.


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