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

#include <mitkFileWriter.h>

Inheritance diagram for mitk::FileWriter:

Collaboration diagram for mitk::FileWriter:

Public Types
typedef FileWriter	Self

typedef itk::ProcessObject	Superclass

typedef itk::SmartPointer< Self >	Pointer

typedef itk::SmartPointer< const Self >	ConstPointer

Public Member Functions
virtual std::vector< std::string >	GetClassHierarchy () const

virtual const char *	GetClassName () const

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...

Static Public Member Functions
static const char *	GetStaticNameOfClass ()

Protected Member Functions
	FileWriter ()

virtual	~FileWriter ()

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 30 of file mitkFileWriter.h.

Member Typedef Documentation

typedef itk::SmartPointer<const Self> mitk::FileWriter::ConstPointer

Definition at line 33 of file mitkFileWriter.h.

typedef itk::SmartPointer<Self> mitk::FileWriter::Pointer

Definition at line 33 of file mitkFileWriter.h.

typedef FileWriter mitk::FileWriter::Self

Definition at line 33 of file mitkFileWriter.h.

typedef itk::ProcessObject mitk::FileWriter::Superclass

Definition at line 33 of file mitkFileWriter.h.

Constructor & Destructor Documentation

mitk::FileWriter::FileWriter ( )

protected

Definition at line 65 of file mitkFileWriter.cpp.

mitk::FileWriter::~FileWriter ( )

protectedvirtual

Definition at line 69 of file mitkFileWriter.cpp.

Member Function Documentation

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

virtual

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

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

Definition at line 19 of file mitkFileWriter.cpp.

References mitk::DataNode::GetData(), and GetSupportedBaseData().

bool mitk::FileWriter::CanWriteToMemory ( )

virtual

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

Definition at line 73 of file mitkFileWriter.cpp.

virtual std::vector<std::string> mitk::FileWriter::GetClassHierarchy ( ) const

inlinevirtual

Reimplemented in mitk::FileWriterWithInformation.

Definition at line 33 of file mitkFileWriter.h.

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

virtual

Reimplemented in mitk::FileWriterWithInformation.

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

virtual

Return the extension to be added to the filename.

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

Definition at line 37 of file mitkFileWriter.cpp.

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, mitk::NrrdTbssRoiImageWriter, mitk::PlanarFigureWriter, mitk::NrrdTbssImageWriter, and mitk::ImageWriter.

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::ImageWriter, mitk::PointSetWriter, mitk::NrrdTbssRoiImageWriter, mitk::PlanarFigureWriter, and mitk::NrrdTbssImageWriter.

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::ImageWriter, mitk::PointSetWriter, mitk::NrrdTbssRoiImageWriter, mitk::PlanarFigureWriter, and mitk::NrrdTbssImageWriter.

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.

Definition at line 85 of file mitkFileWriter.cpp.

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.

Definition at line 89 of file mitkFileWriter.cpp.

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::SurfaceVtkWriter< VTKWRITER >, mitk::SurfaceVtkWriter< VTKWRITER >, mitk::SurfaceVtkWriter< VTKWRITER >, mitk::PointSetWriter, mitk::PlanarFigureWriter, mitk::ImageWriter, mitk::NrrdTbssRoiImageWriter, and mitk::NrrdTbssImageWriter.

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

virtual

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

Definition at line 42 of file mitkFileWriter.cpp.

static const char* mitk::FileWriter::GetStaticNameOfClass ( )

inlinestatic

Definition at line 33 of file mitkFileWriter.h.

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

pure virtual

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

Referenced by CanWriteDataType().

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

virtual

Return the MimeType of the saved File.

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

Definition at line 27 of file mitkFileWriter.cpp.

bool mitk::FileWriter::GetWriteToMemory ( )

virtual

Definition at line 81 of file mitkFileWriter.cpp.

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

Checks if given extension is valid for file writer.

Definition at line 54 of file mitkFileWriter.cpp.

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.

Reimplemented in mitk::PlanarFigureWriter.

Definition at line 93 of file mitkFileWriter.cpp.

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::SurfaceVtkWriter< VTKWRITER >, mitk::PointSetWriter, mitk::NrrdTbssRoiImageWriter, mitk::PlanarFigureWriter, mitk::NrrdTbssImageWriter, and mitk::ImageWriter.

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::ImageWriter, mitk::PointSetWriter, mitk::NrrdTbssRoiImageWriter, mitk::PlanarFigureWriter, and mitk::NrrdTbssImageWriter.

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::ImageWriter, mitk::PointSetWriter, mitk::NrrdTbssRoiImageWriter, mitk::PlanarFigureWriter, and mitk::NrrdTbssImageWriter.

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

Definition at line 32 of file mitkFileWriter.cpp.

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.

Definition at line 77 of file mitkFileWriter.cpp.

virtual void mitk::FileWriter::Write ( )

pure virtual

Member Data Documentation

bool mitk::FileWriter::m_CanWriteToMemory

protected

Definition at line 138 of file mitkFileWriter.h.

Referenced by mitk::PlanarFigureWriter::PlanarFigureWriter().

char* mitk::FileWriter::m_MemoryBuffer

protected

Definition at line 140 of file mitkFileWriter.h.

unsigned int mitk::FileWriter::m_MemoryBufferSize

protected

Definition at line 141 of file mitkFileWriter.h.

bool mitk::FileWriter::m_WriteToMemory

protected

Definition at line 139 of file mitkFileWriter.h.

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

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation