Medical Imaging Interaction Toolkit  2018.4.99-12ad79a3
Medical Imaging Interaction Toolkit
mitk::FileWriterWithInformation Class Referenceabstract

Interface for FileWriters with extra information. Should be merged into FileWriter. More...

#include <mitkFileWriterWithInformation.h>

Inheritance diagram for mitk::FileWriterWithInformation:
Collaboration diagram for mitk::FileWriterWithInformation:

Public Types

typedef FileWriterWithInformation Self
 
typedef FileWriter Superclass
 
typedef itk::SmartPointer< SelfPointer
 
typedef itk::SmartPointer< const SelfConstPointer
 
- Public Types inherited from mitk::FileWriter
typedef FileWriter Self
 
typedef itk::ProcessObject Superclass
 
typedef itk::SmartPointer< SelfPointer
 
typedef itk::SmartPointer< const SelfConstPointer
 

Public Member Functions

virtual std::vector< std::string > GetClassHierarchy () const override
 
virtual const char * GetClassName () const
 
virtual const char * GetDefaultFilename ()=0
 
virtual const char * GetFileDialogPattern ()=0
 
virtual const char * GetDefaultExtension ()=0
 
virtual bool CanWriteBaseDataType (BaseData::Pointer data)=0
 
virtual void DoWrite (BaseData::Pointer data)=0
 
- Public Member Functions inherited from mitk::FileWriter
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 ()
 
- Static Public Member Functions inherited from mitk::FileWriter
static const char * GetStaticNameOfClass ()
 

Additional Inherited Members

- Protected Member Functions inherited from mitk::FileWriter
 FileWriter ()
 
 ~FileWriter () override
 
- Protected Attributes inherited from mitk::FileWriter
bool m_CanWriteToMemory
 
bool m_WriteToMemory
 
char * m_MemoryBuffer
 
unsigned int m_MemoryBufferSize
 

Detailed Description

Interface for FileWriters with extra information. Should be merged into FileWriter.

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

Definition at line 27 of file mitkFileWriterWithInformation.h.

Member Typedef Documentation

◆ ConstPointer

◆ Pointer

◆ Self

◆ Superclass

Member Function Documentation

◆ CanWriteBaseDataType()

◆ DoWrite()

◆ GetClassHierarchy()

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

Reimplemented from mitk::FileWriter.

Definition at line 30 of file mitkFileWriterWithInformation.h.

◆ GetClassName()

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

Reimplemented from mitk::FileWriter.

◆ GetDefaultExtension()

virtual const char* mitk::FileWriterWithInformation::GetDefaultExtension ( )
pure virtual

◆ GetDefaultFilename()

virtual const char* mitk::FileWriterWithInformation::GetDefaultFilename ( )
pure virtual

◆ GetFileDialogPattern()

virtual const char* mitk::FileWriterWithInformation::GetFileDialogPattern ( )
pure virtual

◆ GetStaticNameOfClass()

static const char* mitk::FileWriterWithInformation::GetStaticNameOfClass ( )
inlinestatic

Definition at line 30 of file mitkFileWriterWithInformation.h.


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