Medical Imaging Interaction Toolkit  2018.4.99-1640525a
Medical Imaging Interaction Toolkit
mitk::FileReader Class Referenceabstract

Interface class of readers that read from files. More...

#include <mitkFileReader.h>

Inheritance diagram for mitk::FileReader:

Public Types

typedef FileReader Self
 
typedef itk::SmartPointer< SelfPointer
 
typedef itk::SmartPointer< const SelfConstPointer
 

Public Member Functions

virtual std::vector< std::string > GetClassHierarchy () const
 
 itkTypeMacroNoParent (FileReader) virtual const char *GetFileName() const =0
 Get the specified the file to load. More...
 
virtual void SetFileName (const char *aFileName)=0
 Specify the file to load. More...
 
virtual const char * GetFilePrefix () const =0
 Get the specified file prefix for the file(s) to load. More...
 
virtual void SetFilePrefix (const char *aFilePrefix)=0
 Specify file prefix for the file(s) to load. More...
 
virtual const char * GetFilePattern () const =0
 Get the specified file pattern for the file(s) to load. 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 load. The sprintf format used to build filename from FilePrefix and number. More...
 
virtual bool CanReadFromMemory ()
 Specifies, whether the file reader also can read a file from a memory buffer. More...
 
virtual void SetReadFromMemory (bool read)
 Set/Get functions to advise the file reader to use a memory array for reading a file. More...
 
virtual bool GetReadFromMemory ()
 
virtual void SetMemoryBuffer (const char *dataArray, unsigned int size)
 To be used along with a call of SetReadFromMemory(true). This sets the memory buffer and the size from which the reader will read. More...
 

Static Public Member Functions

static const char * GetStaticNameOfClass ()
 

Protected Member Functions

 FileReader ()
 
virtual ~FileReader ()
 

Protected Attributes

bool m_CanReadFromMemory
 
bool m_ReadFromMemory
 
const char * m_MemoryBuffer
 
unsigned int m_MemorySize
 

Detailed Description

Interface class of readers that read from files.

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

Definition at line 25 of file mitkFileReader.h.

Member Typedef Documentation

◆ ConstPointer

Definition at line 28 of file mitkFileReader.h.

◆ Pointer

Definition at line 28 of file mitkFileReader.h.

◆ Self

Definition at line 28 of file mitkFileReader.h.

Constructor & Destructor Documentation

◆ FileReader()

mitk::FileReader::FileReader ( )
protected

Definition at line 15 of file mitkFileReader.cpp.

◆ ~FileReader()

mitk::FileReader::~FileReader ( )
protectedvirtual

Definition at line 19 of file mitkFileReader.cpp.

Member Function Documentation

◆ CanReadFromMemory()

bool mitk::FileReader::CanReadFromMemory ( )
virtual

Specifies, whether the file reader also can read a file from a memory buffer.

Definition at line 22 of file mitkFileReader.cpp.

References m_CanReadFromMemory.

◆ GetClassHierarchy()

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

Definition at line 28 of file mitkFileReader.h.

◆ GetFilePattern()

virtual const char* mitk::FileReader::GetFilePattern ( ) const
pure virtual

Get the specified file pattern for the file(s) to load. 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::PointSetReader, mitk::RawImageFileReader, mitk::ItkImageFileReader, mitk::VtiFileReader, and mitk::VtkImageReader.

◆ GetFilePrefix()

virtual const char* mitk::FileReader::GetFilePrefix ( ) const
pure virtual

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

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

Implemented in mitk::PointSetReader, mitk::RawImageFileReader, mitk::ItkImageFileReader, mitk::VtiFileReader, and mitk::VtkImageReader.

◆ GetReadFromMemory()

bool mitk::FileReader::GetReadFromMemory ( )
virtual

Definition at line 31 of file mitkFileReader.cpp.

References m_ReadFromMemory.

◆ GetStaticNameOfClass()

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

Definition at line 28 of file mitkFileReader.h.

◆ itkTypeMacroNoParent()

mitk::FileReader::itkTypeMacroNoParent ( FileReader  ) const
pure virtual

Get the specified the file to load.

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

◆ SetFileName()

virtual void mitk::FileReader::SetFileName ( const char *  aFileName)
pure virtual

Specify the file to load.

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

Implemented in mitk::PointSetReader, mitk::RawImageFileReader, mitk::ItkImageFileReader, mitk::VtiFileReader, and mitk::VtkImageReader.

◆ SetFilePattern()

virtual void mitk::FileReader::SetFilePattern ( const char *  aFilePattern)
pure virtual

Specified file pattern for the file(s) to load. 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::PointSetReader, mitk::RawImageFileReader, mitk::ItkImageFileReader, mitk::VtiFileReader, and mitk::VtkImageReader.

◆ SetFilePrefix()

virtual void mitk::FileReader::SetFilePrefix ( const char *  aFilePrefix)
pure virtual

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

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

Implemented in mitk::PointSetReader, mitk::RawImageFileReader, mitk::ItkImageFileReader, mitk::VtiFileReader, and mitk::VtkImageReader.

◆ SetMemoryBuffer()

void mitk::FileReader::SetMemoryBuffer ( const char *  dataArray,
unsigned int  size 
)
virtual

To be used along with a call of SetReadFromMemory(true). This sets the memory buffer and the size from which the reader will read.

Definition at line 35 of file mitkFileReader.cpp.

References m_MemoryBuffer, and m_MemorySize.

◆ SetReadFromMemory()

void mitk::FileReader::SetReadFromMemory ( bool  read)
virtual

Set/Get functions to advise the file reader to use a memory array for reading a file.

Definition at line 27 of file mitkFileReader.cpp.

References m_ReadFromMemory.

Member Data Documentation

◆ m_CanReadFromMemory

bool mitk::FileReader::m_CanReadFromMemory
protected

Definition at line 92 of file mitkFileReader.h.

Referenced by CanReadFromMemory().

◆ m_MemoryBuffer

const char* mitk::FileReader::m_MemoryBuffer
protected

Definition at line 95 of file mitkFileReader.h.

Referenced by SetMemoryBuffer().

◆ m_MemorySize

unsigned int mitk::FileReader::m_MemorySize
protected

Definition at line 96 of file mitkFileReader.h.

Referenced by SetMemoryBuffer().

◆ m_ReadFromMemory

bool mitk::FileReader::m_ReadFromMemory
protected

Definition at line 93 of file mitkFileReader.h.

Referenced by GetReadFromMemory(), and SetReadFromMemory().


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