Public Types | Public Member Functions | Protected Member Functions

mitk::FileWriter Class Reference
[Process Classes]

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

#include <mitkFileWriter.h>

Inheritance diagram for mitk::FileWriter:
Inheritance graph
[legend]

List of all members.

Public Types

typedef FileWriter Self
typedef itk::ProcessObject Superclass
typedef itk::SmartPointer< Self > Pointer
typedef itk::SmartPointer
< const Self > 		ConstPointer

Public Member Functions

virtual const char * GetClassName () const
virtual const char * GetFileName () const =0
 Get the specified the file to write.
virtual void SetFileName (const char *aFileName)=0
 Specify the file to write.
virtual const char * GetFilePrefix () const =0
 Get the specified file prefix for the file(s) to write.
virtual void SetFilePrefix (const char *aFilePrefix)=0
 Specify file prefix for the file(s) to write.
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.
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.
virtual std::string GetFileExtension ()
 Return the extension to be added to the filename.
bool IsExtensionValid (std::string extension)
 Checks if given extension is valid for file writer.
virtual std::vector< std::string > GetPossibleFileExtensions ()=0
 Return the possible file extensions for the data type associated with the writer.
virtual std::string GetPossibleFileExtensionsAsString ()
 possible file extensions for the data type associated with the writer as string
virtual bool CanWriteDataType (DataNode *)
 Check if the Writer can write this type of data of the DataTreenode.
virtual std::string GetWritenMIMEType ()
 Return the MimeType of the saved File.
virtual void SetInput (DataNode *)
 Set the DataTreenode as Input. Important: The Writer always have a SetInput-Function.
virtual void Write ()=0

Protected Member Functions

 FileWriter ()
virtual ~FileWriter ()

Detailed Description

Interface class of writers that write data to files.

Definition at line 31 of file mitkFileWriter.h.

Member Typedef Documentation

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

Reimplemented in mitk::FileWriterWithInformation, mitk::ImageWriter, mitk::PicFileWriter, mitk::PointSetWriter, mitk::SurfaceVtkWriter< VTKWRITER >, mitk::NrrdDiffusionImageWriter< TPixelType >, mitk::NrrdQBallImageWriter, mitk::NrrdTensorImageWriter, mitk::UnstructuredGridVtkWriter< VTKWRITER >, and mitk::PlanarFigureWriter.

Definition at line 34 of file mitkFileWriter.h.

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

Reimplemented in mitk::FileWriterWithInformation, mitk::ImageWriter, mitk::PicFileWriter, mitk::PointSetWriter, mitk::SurfaceVtkWriter< VTKWRITER >, mitk::NrrdDiffusionImageWriter< TPixelType >, mitk::NrrdQBallImageWriter, mitk::NrrdTensorImageWriter, mitk::UnstructuredGridVtkWriter< VTKWRITER >, and mitk::PlanarFigureWriter.

Definition at line 34 of file mitkFileWriter.h.

typedef FileWriter mitk::FileWriter::Self

Reimplemented in mitk::FileWriterWithInformation, mitk::ImageWriter, mitk::PicFileWriter, mitk::PointSetWriter, mitk::SurfaceVtkWriter< VTKWRITER >, mitk::NrrdDiffusionImageWriter< TPixelType >, mitk::NrrdQBallImageWriter, mitk::NrrdTensorImageWriter, mitk::UnstructuredGridVtkWriter< VTKWRITER >, and mitk::PlanarFigureWriter.

Definition at line 34 of file mitkFileWriter.h.

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

Reimplemented in mitk::FileWriterWithInformation, mitk::ImageWriter, mitk::PicFileWriter, mitk::PointSetWriter, mitk::SurfaceVtkWriter< VTKWRITER >, mitk::NrrdDiffusionImageWriter< TPixelType >, mitk::NrrdQBallImageWriter, mitk::NrrdTensorImageWriter, mitk::UnstructuredGridVtkWriter< VTKWRITER >, and mitk::PlanarFigureWriter.

Definition at line 34 of file mitkFileWriter.h.

Constructor & Destructor Documentation

mitk::FileWriter::FileWriter (  ) [protected]

Definition at line 65 of file mitkFileWriter.cpp.

{
}
mitk::FileWriter::~FileWriter (  ) [protected, virtual]

Definition at line 69 of file mitkFileWriter.cpp.

{
}

Member Function Documentation

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

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

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

Definition at line 20 of file mitkFileWriter.cpp.

{
  //TODO #345 check for writing permission
  return false;
}
virtual const char* mitk::FileWriter::GetClassName (  ) const [virtual]

Reimplemented in mitk::FileWriterWithInformation, mitk::ImageWriter, mitk::PicFileWriter, mitk::PointSetWriter, mitk::SurfaceVtkWriter< VTKWRITER >, mitk::NrrdDiffusionImageWriter< TPixelType >, mitk::NrrdQBallImageWriter, mitk::NrrdTensorImageWriter, mitk::UnstructuredGridVtkWriter< VTKWRITER >, and mitk::PlanarFigureWriter.

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

Return the extension to be added to the filename.

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

Definition at line 36 of file mitkFileWriter.cpp.

{
  return "";
}
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::ImageWriter, mitk::PicFileWriter, mitk::PointSetWriter, mitk::SurfaceVtkWriter< VTKWRITER >, mitk::NrrdDiffusionImageWriter< TPixelType >, mitk::NrrdQBallImageWriter, mitk::NrrdTensorImageWriter, mitk::UnstructuredGridVtkWriter< VTKWRITER >, and mitk::PlanarFigureWriter.

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::ImageWriter, mitk::PicFileWriter, mitk::PointSetWriter, mitk::SurfaceVtkWriter< VTKWRITER >, mitk::NrrdDiffusionImageWriter< TPixelType >, mitk::NrrdQBallImageWriter, mitk::NrrdTensorImageWriter, mitk::UnstructuredGridVtkWriter< VTKWRITER >, and mitk::PlanarFigureWriter.

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::ImageWriter, mitk::PicFileWriter, mitk::PointSetWriter, mitk::SurfaceVtkWriter< VTKWRITER >, mitk::NrrdDiffusionImageWriter< TPixelType >, mitk::NrrdQBallImageWriter, mitk::NrrdTensorImageWriter, mitk::UnstructuredGridVtkWriter< VTKWRITER >, and mitk::PlanarFigureWriter.

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::ImageWriter, mitk::PicFileWriter, mitk::PointSetWriter, mitk::SurfaceVtkWriter< VTKWRITER >, mitk::NrrdDiffusionImageWriter< TPixelType >, mitk::NrrdQBallImageWriter, mitk::NrrdTensorImageWriter, mitk::UnstructuredGridVtkWriter< VTKWRITER >, mitk::PlanarFigureWriter, mitk::SurfaceVtkWriter< VTKWRITER >, mitk::SurfaceVtkWriter< VTKWRITER >, mitk::SurfaceVtkWriter< VTKWRITER >, mitk::UnstructuredGridVtkWriter< VTKWRITER >, and mitk::UnstructuredGridVtkWriter< VTKWRITER >.

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

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

Definition at line 41 of file mitkFileWriter.cpp.

{
  std::vector<std::string> possibleFileExtensions = this->GetPossibleFileExtensions();
  std::stringstream stream;
  for (unsigned int i=0; i<possibleFileExtensions.size()-1; i++)
  {
    stream<<"*"<<possibleFileExtensions.at(i)<<" ";
  }
  stream<<"*"<<possibleFileExtensions.at(possibleFileExtensions.size()-1);
  return stream.str();
}
std::string mitk::FileWriter::GetWritenMIMEType (  ) [virtual]

Return the MimeType of the saved File.

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

Definition at line 26 of file mitkFileWriter.cpp.

{
  return "";
}
bool mitk::FileWriter::IsExtensionValid ( std::string  extension )

Checks if given extension is valid for file writer.

Definition at line 53 of file mitkFileWriter.cpp.

{
  std::vector<std::string> possibleFileExtensions = this->GetPossibleFileExtensions();
  for (unsigned int i=0; i<possibleFileExtensions.size(); i++)
  {
    if (strcmp(extension.c_str(),possibleFileExtensions.at(i).c_str())==0)
      return true;
  }
  return false;
}
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::PicFileWriter, mitk::PointSetWriter, mitk::SurfaceVtkWriter< VTKWRITER >, mitk::NrrdDiffusionImageWriter< TPixelType >, mitk::NrrdQBallImageWriter, mitk::NrrdTensorImageWriter, mitk::UnstructuredGridVtkWriter< VTKWRITER >, and mitk::PlanarFigureWriter.

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::ImageWriter, mitk::PicFileWriter, mitk::PointSetWriter, mitk::SurfaceVtkWriter< VTKWRITER >, mitk::NrrdDiffusionImageWriter< TPixelType >, mitk::NrrdQBallImageWriter, mitk::NrrdTensorImageWriter, mitk::UnstructuredGridVtkWriter< VTKWRITER >, and mitk::PlanarFigureWriter.

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::ImageWriter, mitk::PicFileWriter, mitk::PointSetWriter, mitk::SurfaceVtkWriter< VTKWRITER >, mitk::NrrdDiffusionImageWriter< TPixelType >, mitk::NrrdQBallImageWriter, mitk::NrrdTensorImageWriter, mitk::UnstructuredGridVtkWriter< VTKWRITER >, and mitk::PlanarFigureWriter.

void mitk::FileWriter::SetInput ( DataNode *   ) [virtual]

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

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

Definition at line 31 of file mitkFileWriter.cpp.

{
}
virtual void mitk::FileWriter::Write (  ) [pure virtual]

Implemented in mitk::ImageWriter, mitk::PicFileWriter, mitk::PointSetWriter, mitk::SurfaceVtkWriter< VTKWRITER >, mitk::NrrdDiffusionImageWriter< TPixelType >, mitk::NrrdQBallImageWriter, mitk::NrrdTensorImageWriter, mitk::UnstructuredGridVtkWriter< VTKWRITER >, and mitk::PlanarFigureWriter.

The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Defines
Generated on Tue Oct 19 2010 16:20:15 for mitk by  doxygen 1.7.2