Generic writer for every format of Aims object. More...

#include <aims/io/writer.h>

Inheritance diagram for aims::Writer< T >:

Collaboration diagram for aims::Writer< T >:

[legend]

Public Member Functions
	Writer ()

	Writer (const std::string &filename, carto::Object options=carto::none())

virtual	~Writer ()

virtual bool	write (const T &obj, bool ascii=false, const std::string *format=0)
	Finds the correct format and writes the object. More...

virtual std::string	writtenObjectType () const

virtual std::string	writtenObjectDataType () const

virtual std::string	writtenObjectFullType () const

Public Member Functions inherited from aims::GenericWriter
	GenericWriter ()

	GenericWriter (const std::string &filename, carto::Object options=carto::none())

virtual	~GenericWriter ()

template<typename T >
bool	write (const T &obj, bool ascii=false, const std::string *format=0)
	Finds the correct format and writes the object. More...

void	setFileName (const std::string &fileName)
	set output file name More...

const std::string &	fileName () const
	get output file name More...

const carto::Object	options () const

void	setOptions (carto::Object opt)

Additional Inherited Members
Protected Attributes inherited from aims::GenericWriter
std::string	_filename

carto::Object	_options

Detailed Description

template<class T>
class aims::Writer< T >

Generic writer for every format of Aims object.

The Writer classes are built on the same model as the Reader classes and share the same FileFormatDictionary with them to store all known file formats.

See also: FileFormatDictionary Reader

Definition at line 92 of file writer.h.

Constructor & Destructor Documentation

◆ Writer() [1/2]

template<class T>

aims::Writer< T >::Writer ( )

inline

Definition at line 95 of file writer.h.

◆ Writer() [2/2]

template<class T>

aims::Writer< T >::Writer	(	const std::string &	filename,
		carto::Object	options = `carto::none()`
	)

inline

Definition at line 96 of file writer.h.

◆ ~Writer()

template<class T>

virtual aims::Writer< T >::~Writer ( )

inlinevirtual

Definition at line 99 of file writer.h.

References aims::GenericWriter::write(), aims::GenericWriter::writtenObjectDataType(), aims::GenericWriter::writtenObjectFullType(), and aims::GenericWriter::writtenObjectType().

Member Function Documentation

◆ write()

template<class T >

bool aims::Writer< T >::write	(	const T &	obj,
		bool	ascii = `false`,
		const std::string *	format = `0`
	)

virtual

Finds the correct format and writes the object.

If format is specified, this format is tried first, so you can use it to force the format, otherwise it will be determined from the filename extension. If no extension and no format are given, the first working format will be used.

Definition at line 108 of file writer_d.h.

References aims::GenericWriter::_filename, aims::GenericWriter::_options, carto::FileUtil::basename(), aims::FileFormatDictionary< T >::extensions(), aims::FileFormatDictionary< T >::fileFormat(), const_ref< GenericObject >::isNull(), carto::io_error::keepExceptionPriority(), carto::io_error::launchExcept(), carto::PluginLoader::load(), aims::GenericWriter::options(), carto::Object::reference(), aims::Settings::settings(), carto::Object::value(), soma::Writer< T >::write(), and aims::FileFormat< T >::write().