inviwo::JSONReader Class Reference

Inheritance diagram for inviwo::JSONReader:

Public Member Functions
virtual JSONReader *	clone () const override
	JSONReader (const JSONReader &)=default
	JSONReader (JSONReader &&) noexcept=default
JSONReader &	operator= (const JSONReader &)=default
JSONReader &	operator= (JSONReader &&) noexcept=default
virtual std::shared_ptr< json >	readData (const std::filesystem::path &fileName) override
virtual std::shared_ptr< json >	readData (const std::filesystem::path &filePath, MetaDataOwner *) override
virtual std::shared_ptr< json >	readData (const std::filesystem::path &filePath, MetaDataOwner *owner, std::stop_token stop) override
Public Member Functions inherited from inviwo::DataReaderType< json >
	DataReaderType (const DataReaderType &rhs)=default
	DataReaderType (DataReaderType &&rhs) noexcept=default
DataReaderType &	operator= (const DataReaderType &that)=default
DataReaderType &	operator= (DataReaderType &&that) noexcept=default
Public Member Functions inherited from inviwo::DataReader
void	addExtension (FileExtension ext)
	DataReader (const DataReader &rhs)=default
	DataReader (DataReader &&rhs) noexcept=default
const std::vector< FileExtension > &	getExtensions () const
virtual std::any	getOption (std::string_view key)
	Query the value of an reader specific option.
DataReader &	operator= (const DataReader &that)=default
DataReader &	operator= (DataReader &&that) noexcept=default
template<typename T >
bool	readsType () const
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.

Static Public Member Functions
static std::shared_ptr< json >	readData (std::istream &stream)

Additional Inherited Members
Protected Member Functions inherited from inviwo::DataReaderType< json >
virtual bool	canRead (const std::type_index &index) const override
Static Protected Member Functions inherited from inviwo::DataReader
static void	checkExists (const std::filesystem::path &path)
static std::filesystem::path	downloadAndCacheIfUrl (const std::filesystem::path &url)
static filesystem::FileHandle	fopen (const std::filesystem::path &path, const char *mode)
static filesystem::FileHandle	fopenAndCacheIfUrl (const std::filesystem::path &path, const char *mode)
static std::ifstream	open (const std::filesystem::path &path, std::ios_base::openmode mode=std::ios_base::in)
static std::ifstream	openAndCacheIfUrl (const std::filesystem::path &path, std::ios_base::openmode mode=std::ios_base::in)
static std::string	readFileContents (const std::filesystem::path &path)
Protected Attributes inherited from inviwo::DataReader
std::vector< FileExtension >	extensions_

Member Function Documentation

clone()

virtual JSONReader * inviwo::JSONReader::clone ( ) const

overridevirtual

Implements inviwo::DataReaderType< json >.

readData() [1/3]

virtual std::shared_ptr< json > inviwo::JSONReader::readData ( const std::filesystem::path & fileName )

overridevirtual

Implements inviwo::DataReaderType< json >.

readData() [2/3]

virtual std::shared_ptr< json > inviwo::JSONReader::readData ( const std::filesystem::path & filePath, MetaDataOwner *  )

overridevirtual

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 from inviwo::DataReaderType< json >.

readData() [3/3]

virtual std::shared_ptr< json > inviwo::JSONReader::readData ( const std::filesystem::path & filePath, MetaDataOwner * owner, std::stop_token stop )

overridevirtual

Optional overload supporting cancellation. Readers that can abort a long running read should override this, poll stop.stop_requested() at natural checkpoints, and return nullptr as soon as a stop is requested. Note that nullptr is thus a valid, non-exceptional result.

Overriding readers should implement the pure virtual single argument overload by delegating to this one, and add using DataReaderType<T>::readData; to avoid hiding the other overloads.

The default implementation ignores stop and performs an uninterruptible read.

Reimplemented from inviwo::DataReaderType< json >.

---

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

• modules/json/include/modules/json/io/jsonreader.h