ITK  4.13.0
Insight Segmentation and Registration Toolkit
itkByteSwapper.h
Go to the documentation of this file.
1 /*=========================================================================
2  *
3  * Copyright Insight Software Consortium
4  *
5  * Licensed under the Apache License, Version 2.0 (the "License");
6  * you may not use this file except in compliance with the License.
7  * You may obtain a copy of the License at
8  *
9  * http://www.apache.org/licenses/LICENSE-2.0.txt
10  *
11  * Unless required by applicable law or agreed to in writing, software
12  * distributed under the License is distributed on an "AS IS" BASIS,
13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14  * See the License for the specific language governing permissions and
15  * limitations under the License.
16  *
17  *=========================================================================*/
18 /*=========================================================================
19  *
20  * Portions of this file are subject to the VTK Toolkit Version 3 copyright.
21  *
22  * Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
23  *
24  * For complete copyright, license and disclaimer of warranty information
25  * please refer to the NOTICE file at the top of the ITK source tree.
26  *
27  *=========================================================================*/
28 #ifndef itkByteSwapper_h
29 #define itkByteSwapper_h
30 
31 #include "itkObject.h"
32 #include "itkObjectFactory.h"
33 #include "itkIntTypes.h"
34 
35 namespace itk
36 {
49 template< typename T >
50 class ITK_TEMPLATE_EXPORT ByteSwapper:public Object
51 {
52 public:
54  typedef ByteSwapper Self;
55  typedef Object Superclass;
58 
60  typedef std::ostream OStreamType;
61 
63  itkTypeMacro(ByteSwapper, Object);
64 
66  static bool SystemIsBigEndian();
67 
68  static bool SystemIsBE() { return SystemIsBigEndian(); }
69  static bool SystemIsLittleEndian();
70 
71  static bool SystemIsLE() { return SystemIsLittleEndian(); }
72 
78  static void SwapFromSystemToBigEndian(T *p);
79 
83 
89  static void SwapRangeFromSystemToBigEndian(T *p, BufferSizeType num);
90 
98  static void SwapWriteRangeFromSystemToBigEndian(T *p, int num,
99  OStreamType *fp);
101 
107  static void SwapFromSystemToLittleEndian(T *p);
108 
114  static void SwapRangeFromSystemToLittleEndian(T *p, BufferSizeType num);
115 
123  static void SwapWriteRangeFromSystemToLittleEndian(T *p, int num,
124  OStreamType *fp);
126 
127 protected:
129  ~ByteSwapper() ITK_OVERRIDE {}
130 
132  static void Swap2(void *p);
133 
136  static void Swap2Range(void *p, BufferSizeType num);
137 
140  static void SwapWrite2Range(void *p, BufferSizeType num, OStreamType *fp);
141 
143  static void Swap4(void *p);
144 
147  static void Swap4Range(void *p, BufferSizeType num);
148 
151  static void SwapWrite4Range(void *p, BufferSizeType num, OStreamType *fp);
152 
154  static void Swap8(void *p);
155 
158  static void Swap8Range(void *p, BufferSizeType num);
159 
162  static void SwapWrite8Range(void *p, BufferSizeType num, OStreamType *fp);
163 
164 private:
165  ITK_DISALLOW_COPY_AND_ASSIGN(ByteSwapper);
166 };
167 } // end namespace itk
168 
169 #ifndef ITK_MANUAL_INSTANTIATION
170 #include "itkByteSwapper.hxx"
171 #endif
172 
173 #endif
SmartPointer< const Self > ConstPointer
static bool SystemIsBE()
std::ostream OStreamType
SizeValueType BufferSizeType
static bool SystemIsLE()
unsigned long SizeValueType
Definition: itkIntTypes.h:143
ByteSwapper Self
~ByteSwapper() override
Base class for most ITK classes.
Definition: itkObject.h:59
Perform machine dependent byte swapping.
SmartPointer< Self > Pointer