Interface class of writers that write data to files. More...

#include <mitkFileWriter.h>

Inheritance diagram for mitk::FileWriter:

[legend]

Collaboration diagram for mitk::FileWriter:

Public Member Functions
	mitkClassMacroItkParent (FileWriter, itk::ProcessObject)

virtual const char *	GetFileName () const =0
	Get the specified the file to write. More...

virtual void	SetFileName (const char *aFileName)=0
	Specify the file to write. More...

virtual const char *	GetFilePrefix () const =0
	Get the specified file prefix for the file(s) to write. More...

virtual void	SetFilePrefix (const char *aFilePrefix)=0
	Specify file prefix for the file(s) to write. More...

virtual const char *	GetFilePattern () const =0
	Get the specified file pattern for the file(s) to write. The sprintf format used to build filename from FilePrefix and number. More...

virtual void	SetFilePattern (const char *aFilePattern)=0
	Specified file pattern for the file(s) to write. The sprintf format used to build filename from FilePrefix and number. More...

virtual std::string	GetFileExtension ()
	Return the extension to be added to the filename. More...

bool	IsExtensionValid (std::string extension)
	Checks if given extension is valid for file writer. More...

virtual std::vector< std::string >	GetPossibleFileExtensions ()=0
	Return the possible file extensions for the data type associated with the writer. More...

virtual std::string	GetPossibleFileExtensionsAsString ()
	possible file extensions for the data type associated with the writer as string More...

virtual bool	CanWriteDataType (DataNode *)
	Check if the Writer can write this type of data of the DataTreenode. More...

virtual std::string	GetWritenMIMEType ()
	Return the MimeType of the saved File. More...

virtual std::string	GetSupportedBaseData () const =0

void	SetInput (BaseData *data)

virtual void	Write ()=0

virtual bool	CanWriteToMemory ()
	Specifies, whether the file writer also can write a file to a memory buffer. More...

virtual void	SetWriteToMemory (bool write)
	Set/Get functions to advise the file writer to use tis internal memory array as file writing destination. More...

virtual bool	GetWriteToMemory ()

virtual const char *	GetMemoryPointer ()
	To be used along with a call of SetWriteToMemory(true). This returns the memory buffer where the file was written. More...

virtual unsigned int	GetMemorySize ()
	To be used along with a call of SetWriteToMemory(true). This returns the size of the memory buffer where the file was written. More...

virtual void	ReleaseMemory ()
	CAUTION: It's up to the user to call this function to release the memory buffer after use in case the file writer has written to its memory array. More...

Protected Member Functions
	FileWriter ()

	~FileWriter () override

Protected Attributes
bool	m_CanWriteToMemory

bool	m_WriteToMemory

char *	m_MemoryBuffer

unsigned int	m_MemoryBufferSize

Detailed Description

Interface class of writers that write data to files.

Deprecated:: (as of 2014_10) Use mitk::IFileWriter instead.

Definition at line 26 of file mitkFileWriter.h.

Constructor & Destructor Documentation

◆ FileWriter()

mitk::FileWriter::FileWriter ( )

protected

◆ ~FileWriter()

mitk::FileWriter::~FileWriter ( )

overrideprotected

Member Function Documentation

◆ CanWriteDataType()

virtual bool mitk::FileWriter::CanWriteDataType ( DataNode * )

virtual

Check if the Writer can write this type of data of the DataTreenode.

Reimplemented in mitk::SurfaceVtkWriter< VTKWRITER >, mitk::PointSetWriter, and mitk::ImageWriter.

◆ CanWriteToMemory()

virtual bool mitk::FileWriter::CanWriteToMemory ( )

virtual

Specifies, whether the file writer also can write a file to a memory buffer.

◆ GetFileExtension()

virtual std::string mitk::FileWriter::GetFileExtension ( )

virtual

Return the extension to be added to the filename.

Reimplemented in mitk::SurfaceVtkWriter< VTKWRITER >, mitk::PointSetWriter, and mitk::ImageWriter.

◆ GetFileName()

virtual const char* mitk::FileWriter::GetFileName ( ) const

pure virtual

Get the specified the file to write.

Either the FileName or FilePrefix plus FilePattern are used to write.

Implemented in mitk::SurfaceVtkWriter< VTKWRITER >, mitk::PointSetWriter, and mitk::ImageWriter.

◆ GetFilePattern()

virtual const char* mitk::FileWriter::GetFilePattern ( ) const

pure virtual

Get the specified file pattern for the file(s) to write. The sprintf format used to build filename from FilePrefix and number.

You should specify either a FileName or FilePrefix. Use FilePrefix if the data is stored in multiple files.

Implemented in mitk::SurfaceVtkWriter< VTKWRITER >, mitk::PointSetWriter, and mitk::ImageWriter.

◆ GetFilePrefix()

virtual const char* mitk::FileWriter::GetFilePrefix ( ) const

pure virtual

Get the specified file prefix for the file(s) to write.

You should specify either a FileName or FilePrefix. Use FilePrefix if the data is stored in multiple files.

Implemented in mitk::SurfaceVtkWriter< VTKWRITER >, mitk::PointSetWriter, and mitk::ImageWriter.

◆ GetMemoryPointer()

virtual const char* mitk::FileWriter::GetMemoryPointer ( )

virtual

To be used along with a call of SetWriteToMemory(true). This returns the memory buffer where the file was written.

◆ GetMemorySize()

virtual unsigned int mitk::FileWriter::GetMemorySize ( )

virtual

To be used along with a call of SetWriteToMemory(true). This returns the size of the memory buffer where the file was written.

◆ GetPossibleFileExtensions()

virtual std::vector<std::string> mitk::FileWriter::GetPossibleFileExtensions ( )

pure virtual

Return the possible file extensions for the data type associated with the writer.

Implemented in mitk::SurfaceVtkWriter< VTKWRITER >, mitk::PointSetWriter, and mitk::ImageWriter.

◆ GetPossibleFileExtensionsAsString()

virtual std::string mitk::FileWriter::GetPossibleFileExtensionsAsString ( )

virtual

possible file extensions for the data type associated with the writer as string

◆ GetSupportedBaseData()

virtual std::string mitk::FileWriter::GetSupportedBaseData ( ) const

pure virtual

Implemented in mitk::SurfaceVtkWriter< VTKWRITER >, mitk::PointSetWriter, and mitk::ImageWriter.

◆ GetWritenMIMEType()

virtual std::string mitk::FileWriter::GetWritenMIMEType ( )

virtual

Return the MimeType of the saved File.

Reimplemented in mitk::SurfaceVtkWriter< VTKWRITER >, mitk::PointSetWriter, and mitk::ImageWriter.

◆ GetWriteToMemory()

virtual bool mitk::FileWriter::GetWriteToMemory ( )

virtual

◆ IsExtensionValid()

bool mitk::FileWriter::IsExtensionValid ( std::string extension )

Checks if given extension is valid for file writer.

◆ mitkClassMacroItkParent()

mitk::FileWriter::mitkClassMacroItkParent	(	FileWriter	,
		itk::ProcessObject
	)

◆ ReleaseMemory()

virtual void mitk::FileWriter::ReleaseMemory ( )

virtual

CAUTION: It's up to the user to call this function to release the memory buffer after use in case the file writer has written to its memory array.

◆ SetFileName()

virtual void mitk::FileWriter::SetFileName ( const char * aFileName )

pure virtual

Specify the file to write.

Either the FileName or FilePrefix plus FilePattern are used to write.

Implemented in mitk::ImageWriter, mitk::SurfaceVtkWriter< VTKWRITER >, and mitk::PointSetWriter.

◆ SetFilePattern()

virtual void mitk::FileWriter::SetFilePattern ( const char * aFilePattern )

pure virtual

Specified file pattern for the file(s) to write. The sprintf format used to build filename from FilePrefix and number.

You should specify either a FileName or FilePrefix. Use FilePrefix if the data is stored in multiple files.

Implemented in mitk::SurfaceVtkWriter< VTKWRITER >, mitk::PointSetWriter, and mitk::ImageWriter.

◆ SetFilePrefix()

virtual void mitk::FileWriter::SetFilePrefix ( const char * aFilePrefix )

pure virtual

Specify file prefix for the file(s) to write.

You should specify either a FileName or FilePrefix. Use FilePrefix if the data is stored in multiple files.

Implemented in mitk::SurfaceVtkWriter< VTKWRITER >, mitk::PointSetWriter, and mitk::ImageWriter.

◆ SetInput()

void mitk::FileWriter::SetInput ( BaseData * data )

◆ SetWriteToMemory()

virtual void mitk::FileWriter::SetWriteToMemory ( bool write )

virtual

Set/Get functions to advise the file writer to use tis internal memory array as file writing destination.

◆ Write()

virtual void mitk::FileWriter::Write ( )

pure virtual

Member Data Documentation

◆ m_CanWriteToMemory

bool mitk::FileWriter::m_CanWriteToMemory

protected

Definition at line 134 of file mitkFileWriter.h.

◆ m_MemoryBuffer

char* mitk::FileWriter::m_MemoryBuffer

protected

Definition at line 136 of file mitkFileWriter.h.

◆ m_MemoryBufferSize

unsigned int mitk::FileWriter::m_MemoryBufferSize

protected

Definition at line 137 of file mitkFileWriter.h.

◆ m_WriteToMemory

bool mitk::FileWriter::m_WriteToMemory

protected

Definition at line 135 of file mitkFileWriter.h.

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

mitkFileWriter.h

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ FileWriter()

◆ ~FileWriter()

Member Function Documentation

◆ CanWriteDataType()

◆ CanWriteToMemory()

◆ GetFileExtension()

◆ GetFileName()

◆ GetFilePattern()

◆ GetFilePrefix()

◆ GetMemoryPointer()

◆ GetMemorySize()

◆ GetPossibleFileExtensions()

◆ GetPossibleFileExtensionsAsString()

◆ GetSupportedBaseData()

◆ GetWritenMIMEType()

◆ GetWriteToMemory()

◆ IsExtensionValid()

◆ mitkClassMacroItkParent()

◆ ReleaseMemory()

◆ SetFileName()

◆ SetFilePattern()

◆ SetFilePrefix()

◆ SetInput()

◆ SetWriteToMemory()

◆ Write()

Member Data Documentation

◆ m_CanWriteToMemory

◆ m_MemoryBuffer

◆ m_MemoryBufferSize

◆ m_WriteToMemory