inviwo::DataWriterFactory Class Reference

Inheritance diagram for inviwo::DataWriterFactory:

Public Member Functions
bool	registerObject (DataWriter *writer)
bool	unRegisterObject (DataWriter *writer)
virtual std::unique_ptr< DataWriter >	create (std::string_view key) const override
virtual std::unique_ptr< DataWriter >	create (const FileExtension &key) const override
virtual bool	hasKey (std::string_view key) const override
virtual bool	hasKey (const FileExtension &key) const override
auto	getKeyView () const
template<typename T >
std::vector< FileExtension >	getExtensionsForType () const
template<typename... Ts>
std::vector< FileExtension >	getExtensionsForTypes () const
template<typename... Ts>
auto	getExtensionsForTypesView () const
template<typename T >
std::unique_ptr< DataWriterType< T > >	getWriterForTypeAndExtension (const std::filesystem::path &filePathOrExtension) const
	Return a writer matching the file extension of DataWriterType of type T. Does case insensitive comparison between the last part of filePathOrExtension and each registered extension. Does not check for "." before the extension, so it is valid to pass for example "png".
template<typename T >
std::unique_ptr< DataWriterType< T > >	getWriterForTypeAndExtension (const FileExtension &ext) const
template<typename T >
std::unique_ptr< DataWriterType< T > >	getWriterForTypeAndExtension (const FileExtension &ext, const std::filesystem::path &fallbackFilePathOrExtension) const
template<typename T >
bool	hasWriterForTypeAndExtension (const std::filesystem::path &filePathOrExtension) const
template<typename T >
bool	hasWriterForTypeAndExtension (const FileExtension &ext) const
template<typename T >
bool	writeDataForTypeAndExtension (const T *data, const std::filesystem::path &filePath, std::optional< FileExtension > ext=std::nullopt) const
Public Member Functions inherited from inviwo::Factory< DataWriter, const FileExtension & >
	Factory (const Factory &)=delete
	Factory (Factory &&)=default
Factory &	operator= (const Factory &)=delete
Factory &	operator= (Factory &&)=default
virtual std::unique_ptr< DataWriter >	create (const FileExtension &key, Args... args) const=0
virtual std::shared_ptr< DataWriter >	createShared (const FileExtension &key, Args... args) const
Public Member Functions inherited from inviwo::Factory< DataWriter, std::string_view >
	Factory (const Factory &)=delete
	Factory (Factory &&)=default
Factory &	operator= (const Factory &)=delete
Factory &	operator= (Factory &&)=default
virtual std::unique_ptr< DataWriter >	create (std::string_view key, Args... args) const=0
virtual std::shared_ptr< DataWriter >	createShared (std::string_view key, Args... args) const
Public Member Functions inherited from inviwo::Observable< FactoryObserver< DataWriter > >
	Observable (const Observable< FactoryObserver< DataWriter > > &other)
	Observable (Observable< FactoryObserver< DataWriter > > &&other) noexcept
Observable< FactoryObserver< DataWriter > > &	operator= (const Observable< FactoryObserver< DataWriter > > &other)
Observable< FactoryObserver< DataWriter > > &	operator= (Observable< FactoryObserver< DataWriter > > &&other) noexcept
void	addObserver (FactoryObserver< DataWriter > *observer)
void	removeObserver (FactoryObserver< DataWriter > *observer)
virtual void	startBlockingNotifications () override final
virtual void	stopBlockingNotifications () override final
Public Member Functions inherited from inviwo::ObservableInterface

Protected Attributes
std::map< FileExtension, DataWriter * >	map_

Additional Inherited Members
Protected Member Functions inherited from inviwo::FactoryObservable< DataWriter >
void	notifyObserversOnRegister (DataWriter *p)
void	notifyObserversOnUnRegister (DataWriter *p)
Protected Member Functions inherited from inviwo::Observable< FactoryObserver< DataWriter > >
void	forEachObserver (C callback)
Protected Member Functions inherited from inviwo::ObservableInterface
void	addObservationHelper (Observer *observer)
void	removeObservationHelper (Observer *observer)

Member Function Documentation

getWriterForTypeAndExtension() [1/2]

template<typename T >

std::unique_ptr< DataWriterType< T > > inviwo::DataWriterFactory::getWriterForTypeAndExtension	(	const FileExtension &	ext,
		const std::filesystem::path &	fallbackFilePathOrExtension ) const

First look for a writer using the FileExtension ext, and if no writer was found look for a writer using the fallbackFilePathOrExtension. This is often used with a file open dialog, where the dialog will have a selectedFileExtension that will be used as ext, and the fallbackFilePathOrExtension is taken from the file to be written. This way any selected writer will have priority over the file extension.

getWriterForTypeAndExtension() [2/2]

template<typename T >

std::unique_ptr< DataWriterType< T > > inviwo::DataWriterFactory::getWriterForTypeAndExtension

(

const std::filesystem::path &

filePathOrExtension

)

const

Return a writer matching the file extension of DataWriterType of type T. Does case insensitive comparison between the last part of filePathOrExtension and each registered extension. Does not check for "." before the extension, so it is valid to pass for example "png".

Parameters

filePathOrExtension

Path to file, or simply the extension.

Returns

First available DataWriterType<T> if found, nullptr otherwise.

hasKey() [1/2]

virtual bool inviwo::DataWriterFactory::hasKey ( const FileExtension & key ) const

overridevirtual

Implements inviwo::Factory< DataWriter, const FileExtension & >.

hasKey() [2/2]

virtual bool inviwo::DataWriterFactory::hasKey ( std::string_view key ) const

overridevirtual

Implements inviwo::Factory< DataWriter, std::string_view >.

---

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

• datawriterfactory.h