mitk::PlanarFigureWriter Class Reference

XML-based writer for mitk::PlanarFigures. More...

#include <mitkPlanarFigureWriter.h>

Inheritance diagram for mitk::PlanarFigureWriter:

Collaboration diagram for mitk::PlanarFigureWriter:

Public Types
typedef mitk::PlanarFigure	InputType
typedef InputType::Pointer	InputTypePointer
Public Types inherited from mitk::FileWriterWithInformation
typedef FileWriterWithInformation	Self
typedef FileWriter	Superclass
typedef itk::SmartPointer< Self >	Pointer
typedef itk::SmartPointer< const Self >	ConstPointer
Public Types inherited from mitk::FileWriter
typedef FileWriter	Self
typedef itk::ProcessObject	Superclass
typedef itk::SmartPointer< Self >	Pointer
typedef itk::SmartPointer< const Self >	ConstPointer

Public Member Functions
	mitkClassMacro (PlanarFigureWriter, mitk::FileWriter)
Pointer	Clone () const
virtual void	SetFileName (const char *_arg)
virtual const char *	GetFileName () const
virtual void	SetFilePrefix (const char *_arg)
virtual const char *	GetFilePrefix () const
virtual void	SetFilePattern (const char *_arg)
virtual const char *	GetFilePattern () const
void	SetInput (InputType *input)
void	SetInput (const unsigned int &num, InputType *input)
PlanarFigure *	GetInput ()
PlanarFigure *	GetInput (const unsigned int &num)
std::vector< std::string >	GetPossibleFileExtensions () override
	Return the possible file extensions for the data type associated with the writer. More...
std::string	GetFileExtension () override
	Return the extension to be added to the filename. More...
bool	CanWriteDataType (DataNode *) override
	Check if the Writer can write the Content of the. More...
std::string	GetWritenMIMEType () override
	Return the MimeType of the saved File. More...
virtual void	SetInput (DataNode *)
	Set the DataTreenode as Input. Important: The Writer always have a SetInput-Function. More...
std::string	GetSupportedBaseData () const override
virtual bool	GetSuccess () const
const char *	GetDefaultFilename () override
const char *	GetFileDialogPattern () override
const char *	GetDefaultExtension () override
bool	CanWriteBaseDataType (BaseData::Pointer data) override
void	DoWrite (BaseData::Pointer data) override
void	ReleaseMemory () override
	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. See mitkFileWriter base class. More...
Public Member Functions inherited from mitk::FileWriterWithInformation
virtual std::vector< std::string >	GetClassHierarchy () const override
virtual const char *	GetClassName () const
Public Member Functions inherited from mitk::FileWriter
bool	IsExtensionValid (std::string extension)
	Checks if given extension is valid for file writer. More...
virtual std::string	GetPossibleFileExtensionsAsString ()
	possible file extensions for the data type associated with the writer as string More...
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...

Static Public Member Functions
static Pointer	New ()
Static Public Member Functions inherited from mitk::FileWriterWithInformation
static const char *	GetStaticNameOfClass ()
Static Public Member Functions inherited from mitk::FileWriter
static const char *	GetStaticNameOfClass ()

Public Attributes
	mitkWriterMacro

Protected Member Functions
	PlanarFigureWriter ()
	~PlanarFigureWriter () override
void	GenerateData () override
virtual void	ResizeInputs (const unsigned int &num)
TiXmlElement *	CreateXMLVectorElement (const char *name, itk::FixedArray< mitk::ScalarType, 3 > v)
	creates a TinyXML element that contains x, y, and z values More...
Protected Member Functions inherited from mitk::FileWriter
	FileWriter ()
	~FileWriter () override

Protected Attributes
std::string	m_FileName
std::string	m_FilePrefix
std::string	m_FilePattern
std::string	m_Extension
std::string	m_MimeType
bool	m_Success
Protected Attributes inherited from mitk::FileWriter
bool	m_CanWriteToMemory
bool	m_WriteToMemory
char *	m_MemoryBuffer
unsigned int	m_MemoryBufferSize

Detailed Description

XML-based writer for mitk::PlanarFigures.

XML-based writer for mitk::PlanarFigures.

Definition at line 30 of file mitkPlanarFigureWriter.h.

Member Typedef Documentation

InputType

typedef mitk::PlanarFigure mitk::PlanarFigureWriter::InputType

Definition at line 39 of file mitkPlanarFigureWriter.h.

InputTypePointer

typedef InputType::Pointer mitk::PlanarFigureWriter::InputTypePointer

Definition at line 43 of file mitkPlanarFigureWriter.h.

Constructor & Destructor Documentation

PlanarFigureWriter()

mitk::PlanarFigureWriter::PlanarFigureWriter ( )

protected

Constructor.

Definition at line 18 of file mitkPlanarFigureWriter.cpp.

References mitk::FileWriter::m_CanWriteToMemory.

~PlanarFigureWriter()

mitk::PlanarFigureWriter::~PlanarFigureWriter ( )

overrideprotected

Virtual destructor.

Definition at line 33 of file mitkPlanarFigureWriter.cpp.

Member Function Documentation

CanWriteBaseDataType()

bool mitk::PlanarFigureWriter::CanWriteBaseDataType ( BaseData::Pointer  data )

inlineoverridevirtual

Implements mitk::FileWriterWithInformation.

Definition at line 138 of file mitkPlanarFigureWriter.h.

CanWriteDataType()

bool mitk::PlanarFigureWriter::CanWriteDataType ( DataNode *  input )

overridevirtual

Check if the Writer can write the Content of the.

Reimplemented from mitk::FileWriter.

Definition at line 252 of file mitkPlanarFigureWriter.cpp.

References mitk::DataNode::GetData().

Referenced by SetInput().

Clone()

Pointer mitk::PlanarFigureWriter::Clone

(

)

const

CreateXMLVectorElement()

TiXmlElement * mitk::PlanarFigureWriter::CreateXMLVectorElement ( const char *  name, itk::FixedArray< mitk::ScalarType, 3 >  v  )

protected

creates a TinyXML element that contains x, y, and z values

Documentation

Parameters

[in]	name	the name of the XML element
[in]	v	the vector or point that contains the x, y and z values

Returns

returns a TiXmlElement named name and three attributes x, y and z.

Definition at line 208 of file mitkPlanarFigureWriter.cpp.

Referenced by GenerateData().

DoWrite()

void mitk::PlanarFigureWriter::DoWrite ( BaseData::Pointer  data )

inlineoverridevirtual

Implements mitk::FileWriterWithInformation.

Definition at line 142 of file mitkPlanarFigureWriter.h.

References Update().

GenerateData()

void mitk::PlanarFigureWriter::GenerateData ( )

overrideprotected

Writes the a .pf file in xml format that contains all input planar figures

Definition at line 37 of file mitkPlanarFigureWriter.cpp.

References CreateXMLVectorElement(), mitk::BaseGeometry::GetIndexToWorldTransform(), GetInput(), m_FileName, mitk::FileWriter::m_MemoryBuffer, mitk::FileWriter::m_MemoryBufferSize, m_Success, mitk::FileWriter::m_WriteToMemory, and MITK_ERROR.

GetDefaultExtension()

const char* mitk::PlanarFigureWriter::GetDefaultExtension ( )

inlineoverridevirtual

Implements mitk::FileWriterWithInformation.

Definition at line 137 of file mitkPlanarFigureWriter.h.

GetDefaultFilename()

const char* mitk::PlanarFigureWriter::GetDefaultFilename ( )

inlineoverridevirtual

Implements mitk::FileWriterWithInformation.

Definition at line 135 of file mitkPlanarFigureWriter.h.

GetFileDialogPattern()

const char* mitk::PlanarFigureWriter::GetFileDialogPattern ( )

inlineoverridevirtual

Implements mitk::FileWriterWithInformation.

Definition at line 136 of file mitkPlanarFigureWriter.h.

GetFileExtension()

std::string mitk::PlanarFigureWriter::GetFileExtension ( )

overridevirtual

Return the extension to be added to the filename.

Reimplemented from mitk::FileWriter.

Definition at line 291 of file mitkPlanarFigureWriter.cpp.

References m_Extension.

GetFileName()

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

virtual

Returns

the name of the file to be written to disk.

Implements mitk::FileWriter.

GetFilePattern()

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

virtual

Warning

multiple write not (yet) supported

Implements mitk::FileWriter.

GetFilePrefix()

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

virtual

Warning

multiple write not (yet) supported

Implements mitk::FileWriter.

GetInput() [1/2]

mitk::PlanarFigure * mitk::PlanarFigureWriter::GetInput

(

void

)

Returns

the 0'th input object of the filter.

Definition at line 239 of file mitkPlanarFigureWriter.cpp.

Referenced by GenerateData().

GetInput() [2/2]

mitk::PlanarFigure * mitk::PlanarFigureWriter::GetInput

(

const unsigned int &

num

)

Parameters

num	the index of the desired output object.

Returns

the n'th input object of the filter.

Definition at line 247 of file mitkPlanarFigureWriter.cpp.

GetPossibleFileExtensions()

std::vector< std::string > mitk::PlanarFigureWriter::GetPossibleFileExtensions ( )

overridevirtual

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

Implements mitk::FileWriter.

Definition at line 284 of file mitkPlanarFigureWriter.cpp.

References m_Extension.

GetSuccess()

virtual bool mitk::PlanarFigureWriter::GetSuccess ( ) const

virtual

Returns

whether the last write attempt was successful or not.

GetSupportedBaseData()

std::string mitk::PlanarFigureWriter::GetSupportedBaseData ( ) const

overridevirtual

Implements mitk::FileWriter.

Definition at line 274 of file mitkPlanarFigureWriter.cpp.

References mitk::BaseData::GetStaticNameOfClass().

GetWritenMIMEType()

std::string mitk::PlanarFigureWriter::GetWritenMIMEType ( )

overridevirtual

Return the MimeType of the saved File.

Reimplemented from mitk::FileWriter.

Definition at line 279 of file mitkPlanarFigureWriter.cpp.

References m_MimeType.

mitkClassMacro()

mitk::PlanarFigureWriter::mitkClassMacro	(	PlanarFigureWriter	,
		mitk::FileWriter
	)

New()

static Pointer mitk::PlanarFigureWriter::New ( )

static

Referenced by Clone(), mitk::PlanarFigureObjectFactory::PlanarFigureObjectFactory(), and mitk::PlanarFigureSerializer::Serialize().

ReleaseMemory()

void mitk::PlanarFigureWriter::ReleaseMemory ( )

overridevirtual

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. See mitkFileWriter base class.

Reimplemented from mitk::FileWriter.

Definition at line 200 of file mitkPlanarFigureWriter.cpp.

References mitk::FileWriter::m_MemoryBuffer.

ResizeInputs()

void mitk::PlanarFigureWriter::ResizeInputs ( const unsigned int &  num )

protectedvirtual

Resizes the number of inputs of the writer. The inputs are initialized by empty PlanarFigures

Parameters

num	the new number of inputs

Definition at line 217 of file mitkPlanarFigureWriter.cpp.

Referenced by SetInput().

SetFileName()

virtual void mitk::PlanarFigureWriter::SetFileName ( const char *  _arg )

virtual

Sets the filename of the file to write.

Parameters

FileName

the name of the file to write.

Implements mitk::FileWriter.

SetFilePattern()

virtual void mitk::PlanarFigureWriter::SetFilePattern ( const char *  _arg )

virtual

Warning

multiple write not (yet) supported

Implements mitk::FileWriter.

SetFilePrefix()

virtual void mitk::PlanarFigureWriter::SetFilePrefix ( const char *  _arg )

virtual

Warning

multiple write not (yet) supported

Implements mitk::FileWriter.

SetInput() [1/3]

void mitk::PlanarFigureWriter::SetInput

(

InputType *

input

)

Sets the 0'th input object for the filter.

Parameters

input

the first input for the filter.

Definition at line 227 of file mitkPlanarFigureWriter.cpp.

SetInput() [2/3]

void mitk::PlanarFigureWriter::SetInput	(	const unsigned int &	num,
		InputType *	input
	)

Sets the n'th input object for the filter. If num is larger than GetNumberOfInputs() the number of inputs is resized appropriately.

Parameters

input

the n'th input for the filter.

Definition at line 232 of file mitkPlanarFigureWriter.cpp.

References ResizeInputs().

SetInput() [3/3]

void mitk::PlanarFigureWriter::SetInput ( DataNode *  input )

virtual

Set the DataTreenode as Input. Important: The Writer always have a SetInput-Function.

Definition at line 268 of file mitkPlanarFigureWriter.cpp.

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

Member Data Documentation

m_Extension

std::string mitk::PlanarFigureWriter::m_Extension

protected

Definition at line 192 of file mitkPlanarFigureWriter.h.

Referenced by GetFileExtension(), and GetPossibleFileExtensions().

m_FileName

std::string mitk::PlanarFigureWriter::m_FileName

protected

Definition at line 189 of file mitkPlanarFigureWriter.h.

Referenced by GenerateData().

m_FilePattern

std::string mitk::PlanarFigureWriter::m_FilePattern

protected

Definition at line 191 of file mitkPlanarFigureWriter.h.

m_FilePrefix

std::string mitk::PlanarFigureWriter::m_FilePrefix

protected

Definition at line 190 of file mitkPlanarFigureWriter.h.

m_MimeType

std::string mitk::PlanarFigureWriter::m_MimeType

protected

Definition at line 193 of file mitkPlanarFigureWriter.h.

Referenced by GetWritenMIMEType().

m_Success

bool mitk::PlanarFigureWriter::m_Success

protected

Definition at line 194 of file mitkPlanarFigureWriter.h.

Referenced by GenerateData().

mitkWriterMacro

mitk::PlanarFigureWriter::mitkWriterMacro

Definition at line 35 of file mitkPlanarFigureWriter.h.

---

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

• mitkPlanarFigureWriter.h
• mitkPlanarFigureWriter.cpp