mitkFileReader.h

Go to the documentation of this file.

/*============================================================================
 
The Medical Imaging Interaction Toolkit (MITK)
 
Copyright (c) German Cancer Research Center (DKFZ)
All rights reserved.
 
Use of this source code is governed by a 3-clause BSD license that can be
found in the LICENSE file.
 
============================================================================*/
 
#ifndef mitkFileReader_h
#define mitkFileReader_h
 
#include <MitkCoreExports.h>
#include <mitkCommon.h>
 
namespace mitk
{
  //##Documentation
  //## @brief Interface class of readers that read from files
  //## @ingroup DeprecatedIO
  //## @deprecatedSince{2014_10} Use mitk::IFileReader instead.
  class MITKCORE_EXPORT FileReader
  {
  public:
    mitkClassMacroNoParent(FileReader)
 
      //##Documentation
      //## @brief Get the specified the file to load.
      //##
      //## Either the FileName or FilePrefix plus FilePattern are used to read.
      virtual const char *GetFileName() const = 0;
 
    //##Documentation
    //## @brief Specify the file to load.
    //##
    //## Either the FileName or FilePrefix plus FilePattern are used to read.
    virtual void SetFileName(const char *aFileName) = 0;
 
    //##Documentation
    //## @brief 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.
    virtual const char *GetFilePrefix() const = 0;
 
    //##Documentation
    //## @brief 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.
    virtual void SetFilePrefix(const char *aFilePrefix) = 0;
 
    //##Documentation
    //## @brief 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.
    virtual const char *GetFilePattern() const = 0;
 
    virtual void SetFilePattern(const char *aFilePattern) = 0;
 
    virtual bool CanReadFromMemory();
 
    virtual void SetReadFromMemory(bool read);
    virtual bool GetReadFromMemory();
 
    virtual void SetMemoryBuffer(const char *dataArray, unsigned int size);
 
  protected:
    FileReader();
    virtual ~FileReader();
 
    bool m_CanReadFromMemory;
    bool m_ReadFromMemory;
 
    const char *m_MemoryBuffer;
    unsigned int m_MemorySize;
 
  public:
  protected:
  };
} // namespace mitk
#endif