Low-level object IO format: each specific format has such a reader / writer. More...

#include <aims/io/fileFormat.h>

Inheritance diagram for aims::FileFormat< T >:

[legend]

Public Member Functions
virtual	~FileFormat ()

virtual bool	read (const std::string &filename, T &obj, const carto::AllocatorContext &context, carto::Object options)=0

virtual T *	read (const std::string &filename, const carto::AllocatorContext &context, carto::Object options)
	Creates an object and reads it. More...

virtual bool	write (const std::string &, const T &, carto::Object options=carto::none())
	the base class has a default implementation which only returns `false` so if your new format only supports read operations, you won't have to bother about the write() function More...

template<>
carto::GenericObject *	read (const std::string &, const carto::AllocatorContext &, carto::Object)

Detailed Description

template<class T>
class aims::FileFormat< T >

Low-level object IO format: each specific format has such a reader / writer.

Definition at line 61 of file fileFormat.h.

Constructor & Destructor Documentation

◆ ~FileFormat()

template<typename T >

aims::FileFormat< T >::~FileFormat ( )

virtual

Definition at line 46 of file fileFormat_d.h.

Member Function Documentation

◆ read() [1/3]

template<>

carto::GenericObject * aims::FileFormat< carto::GenericObject >::read	(	const std::string &	,
		const carto::AllocatorContext &	,
		carto::Object
	)

inline

Definition at line 46 of file baseFormats_genericobject.h.

◆ read() [2/3]

template<class T>

virtual bool aims::FileFormat< T >::read	(	const std::string &	filename,
		T &	obj,
		const carto::AllocatorContext &	context,
		carto::Object	options
	)

pure virtual

◆ read() [3/3]

template<typename T >

T * aims::FileFormat< T >::read	(	const std::string &	filename,
		const carto::AllocatorContext &	context,
		carto::Object	options
	)

virtual

Creates an object and reads it.

The default implementation just calls the other read() function. The returned object may be deleted by the standard delete

Reimplemented in aims::SomaIOAimsDataFormat< T >, aims::VolumeRefFormat< T >, aims::GraphVolumeFormat, aims::MinfFormat< T >, aims::VolumeFormat< T >, aims::GraphBundlesFormat, and aims::ArgFormat.

Definition at line 52 of file fileFormat_d.h.

◆ write()

template<typename T >

bool aims::FileFormat< T >::write	(	const std::string &	,
		const T &	,
		carto::Object	options = `carto::none()`
	)

virtual

the base class has a default implementation which only returns false so if your new format only supports read operations, you won't have to bother about the write() function

Reimplemented in aims::WavefrontMeshFormat< D, T >, aims::MniObjFormat, aims::Vrml1Format, aims::SomaIOAimsDataFormat< T >, aims::PovFormat< D >, aims::VolumeRefFormat< T >, aims::ImasVolFormat< T >, aims::GiftiTextureFormat< T >, aims::TriFormat, aims::BckMapFormat< T >, aims::MinfFormat< T >, aims::ArgFormat, aims::VolumeFormat< T >, aims::MeshFormat< D, T >, aims::BckFormat< T >, aims::TrmFormat, aims::SpmFormat< T >, and aims::GiftiMeshFormat< D, T >.

Definition at line 73 of file fileFormat_d.h.

Referenced by aims::Writer< T >::write().

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

aims/io/fileFormat.h
aims/io/fileFormat_d.h

Public Member Functions

Detailed Description

template<class T> class aims::FileFormat< T >

Constructor & Destructor Documentation

◆ ~FileFormat()

Member Function Documentation

◆ read() [1/3]

◆ read() [2/3]

◆ read() [3/3]

◆ write()

template<class T>
class aims::FileFormat< T >