mitk::FileSeriesReader Class Reference

#include <mitkFileSeriesReader.h>

Inheritance diagram for mitk::FileSeriesReader:

Collaboration diagram for mitk::FileSeriesReader:

Public Member Functions
virtual mitkClassMacro(FileSeriesReader, FileReader) typedef std MatchedFileNames	GetMatchedFileNames ()
Public Member Functions inherited from mitk::FileReader
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...

Protected Member Functions
	FileSeriesReader ()
virtual	~FileSeriesReader ()
virtual bool	GenerateFileList ()
Protected Member Functions inherited from mitk::FileReader
	FileReader ()
virtual	~FileReader ()

Protected Attributes
std::string	m_FileName
std::string	m_FilePrefix
std::string	m_FilePattern
MatchedFileNames	m_MatchedFileNames
Protected Attributes inherited from mitk::FileReader
bool	m_CanReadFromMemory
bool	m_ReadFromMemory
const char *	m_MemoryBuffer
unsigned int	m_MemorySize

Additional Inherited Members
Public Types inherited from mitk::FileReader
typedef FileReader	Self
typedef itk::SmartPointer< Self >	Pointer
typedef itk::SmartPointer< const Self >	ConstPointer
Static Public Member Functions inherited from mitk::FileReader
static const char *	GetStaticNameOfClass ()

Detailed Description

Provides a function which generates a list of files from a given prefix and pattern. Subclasses may use this function to load a series of files.

Deprecated:

(as of 2014_10)

Definition at line 35 of file mitkFileSeriesReader.h.

Constructor & Destructor Documentation

mitk::FileSeriesReader::FileSeriesReader ( )

protected

Definition at line 252 of file mitkFileSeriesReader.cpp.

mitk::FileSeriesReader::~FileSeriesReader ( )

protectedvirtual

Definition at line 256 of file mitkFileSeriesReader.cpp.

Member Function Documentation

bool mitk::FileSeriesReader::GenerateFileList ( )

protectedvirtual

Definition at line 23 of file mitkFileSeriesReader.cpp.

References filename, m_FileName, m_MatchedFileNames, and MITK_INFO.

mitk::FileSeriesReader::MatchedFileNames mitk::FileSeriesReader::GetMatchedFileNames ( )

virtual

Definition at line 247 of file mitkFileSeriesReader.cpp.

Member Data Documentation

std::string mitk::FileSeriesReader::m_FileName

protected

Definition at line 51 of file mitkFileSeriesReader.h.

Referenced by GenerateFileList().

std::string mitk::FileSeriesReader::m_FilePattern

protected

Definition at line 55 of file mitkFileSeriesReader.h.

std::string mitk::FileSeriesReader::m_FilePrefix

protected

Definition at line 53 of file mitkFileSeriesReader.h.

MatchedFileNames mitk::FileSeriesReader::m_MatchedFileNames

protected

Definition at line 57 of file mitkFileSeriesReader.h.

Referenced by GenerateFileList().

---

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

• mitkFileSeriesReader.h
• mitkFileSeriesReader.cpp