itkStreamingImageIOBase.h

Go to the documentation of this file.

/*=========================================================================

  Program:   Insight Segmentation & Registration Toolkit
  Module:    $RCSfile: itkStreamingImageIOBase.h,v $
  Language:  C++
  Date:      $Date: 2010-06-14 15:00:28 $
  Version:   $Revision: 1.3 $

  Copyright (c) Insight Software Consortium. All rights reserved.
  See ITKCopyright.txt or http://www.itk.org/HTML/Copyright.htm for details.

     This software is distributed WITHOUT ANY WARRANTY; without even 
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR 
     PURPOSE.  See the above copyright notices for more information.

=========================================================================*/
#ifndef __itkStreamingImageIOBase_h
#define __itkStreamingImageIOBase_h

#include "itkImageIOBase.h"

#include <fstream>

namespace itk
{

class ITK_EXPORT StreamingImageIOBase : public ImageIOBase
{
public:
  typedef StreamingImageIOBase Self;
  typedef ImageIOBase          Superclass;
  typedef SmartPointer<Self>   Pointer;

  itkTypeMacro(StreamingImageIOBase, ImageIOBase);

  // see super class for documentation
  // 
  // overidden to return true
  virtual bool CanStreamWrite( void );

  // see super class for documentation
  //
  // overidden to return true
  virtual bool CanStreamRead( void );

  // see super class for documentation
  //
  // If UseStreamedReading is true, then returned region is the
  // requested region parameter. 
  virtual ImageIORegion GenerateStreamableReadRegionFromRequestedRegion( const ImageIORegion & requested ) const;

  // see super class for documentation
  //
  // Verifies the set file name meets the pasting requirements, then calls
  // GetActualNumberOfSplitsForWritingCanStreamWrite 
  virtual unsigned int GetActualNumberOfSplitsForWriting( unsigned int numberOfRequestedSplits,
                                                          const ImageIORegion &pasteRegion,
                                                          const ImageIORegion &largestPossibleRegion );
    
protected:
  StreamingImageIOBase();
  // virtual ~StreamingImageIOBase(); not needed
  virtual void PrintSelf(std::ostream& os, Indent indent) const;

  
  virtual bool RequestedToStream( void ) const;
  

  virtual bool ReadBufferAsBinary( std::istream& is, void *buffer, SizeType num );

  
  virtual bool WriteBufferAsBinary( std::ostream& is, const void *buffer, SizeType num );

  
  virtual bool StreamReadBufferAsBinary(std::istream& os, void *buffer);
  
  virtual bool StreamWriteBufferAsBinary(std::ostream& os, const void *buffer);


  virtual SizeType GetHeaderSize(void ) const = 0;

  virtual SizeType GetDataPosition( void ) const { return this->GetHeaderSize(); };

  
  virtual void OpenFileForReading(std::ifstream& os, const char* filename);

  virtual void OpenFileForWriting(std::ofstream& os, const char* filename, bool truncate);

private:
  StreamingImageIOBase(const Self&); //purposely not implemented
  void operator=(const Self&); //purposely not implemented


};

} // namespace itk


#endif