itkByteSwapper.h

Go to the documentation of this file.

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

  Program:   Insight Segmentation & Registration Toolkit
  Module:    $RCSfile: itkByteSwapper.h,v $
  Language:  C++
  Date:      $Date: 2009-12-08 19:53:43 $
  Version:   $Revision: 1.17 $

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

  Portions of this code are covered under the VTK copyright.
  See VTKCopyright.txt or http://www.kitware.com/VTKCopyright.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 __itkByteSwapper_h
#define __itkByteSwapper_h

#include "itkObject.h"
#include "itkObjectFactory.h"

namespace itk
{

template <class T>
class ITK_EXPORT ByteSwapper : public Object
{
public:
  typedef ByteSwapper               Self;
  typedef Object                    Superclass;
  typedef SmartPointer<Self>        Pointer;
  typedef SmartPointer<const Self>  ConstPointer;

  typedef std::ostream OStreamType;

  itkTypeMacro(ByteSwapper,Object);

  static bool SystemIsBigEndian ();
  static bool SystemIsBE () { return SystemIsBigEndian(); }
  static bool SystemIsLittleEndian ();
  static bool SystemIsLE () { return SystemIsLittleEndian(); }

  static void SwapFromSystemToBigEndian(T *p);

  typedef  ::size_t      BufferSizeType;

  static void SwapRangeFromSystemToBigEndian(T *p, BufferSizeType num);

  static void SwapWriteRangeFromSystemToBigEndian(T *p, int num, 
                                                  OStreamType *fp);

  static void SwapFromSystemToLittleEndian(T *p);

  static void SwapRangeFromSystemToLittleEndian(T *p, BufferSizeType num);

  static void SwapWriteRangeFromSystemToLittleEndian(T *p, int num, 
                                                     OStreamType *fp);

protected:
  ByteSwapper() {}
  ~ByteSwapper() {}

  static void Swap2(void *p);

  static void Swap2Range(void *p, BufferSizeType num);

  static void SwapWrite2Range(void *p, BufferSizeType num, OStreamType *fp);

  static void Swap4(void *p);

  static void Swap4Range(void *p, BufferSizeType num);

  static void SwapWrite4Range(void *p, BufferSizeType num, OStreamType *fp);

  static void Swap8(void *p);

  static void Swap8Range(void *p, BufferSizeType num);

  static void SwapWrite8Range(void *p, BufferSizeType num, OStreamType *fp);

private:
  ByteSwapper(const ByteSwapper&); //purposely not implemented
  void operator=(const ByteSwapper&); //purposely not implemented
  
};

} // end namespace itk
  
#ifndef ITK_MANUAL_INSTANTIATION
#include "itkByteSwapper.txx"
#endif

#endif