Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members   Related Pages  

vtkByteSwap Class Reference

perform machine dependent byte swapping. More...

#include <vtkByteSwap.h>

Inheritance diagram for vtkByteSwap:

Inheritance graph
[legend]
Collaboration diagram for vtkByteSwap:

Collaboration graph
[legend]
List of all members.

Public Methods

virtual const char * GetClassName ()
virtual int IsA (const char *type)

Static Public Methods

vtkByteSwap * New ()
int IsTypeOf (const char *type)
vtkByteSwap * SafeDownCast (vtkObject *o)
void SwapVoidRange (void *buffer, int numWords, int wordSize)
void Swap2LE (short *s)
void Swap2LE (unsigned short *s)
void Swap4LE (char *c)
void Swap4LE (float *p)
void Swap4LE (int *i)
void Swap4LE (unsigned long *i)
void Swap4LE (long *i)
void Swap8LE (char *c)
void Swap8LE (double *d)
void Swap2LERange (char *c, int num)
void Swap2LERange (short *i, int num)
void Swap4LERange (char *c, int num)
void Swap4LERange (unsigned char *c, int num)
void Swap4LERange (float *p, int num)
void Swap4LERange (int *i, int num)
void Swap4LERange (unsigned long *i, int num)
void Swap8LERange (char *c, int num)
void Swap8LERange (double *d, int num)
void Swap2BE (short *s)
void Swap2BE (unsigned short *s)
void Swap4BE (char *c)
void Swap4BE (float *p)
void Swap4BE (int *i)
void Swap4BE (unsigned long *i)
void Swap8BE (char *c)
void Swap8BE (double *d)
void Swap2BERange (char *c, int num)
void Swap2BERange (short *i, int num)
void Swap4BERange (char *c, int num)
void Swap4BERange (float *p, int num)
void Swap4BERange (int *i, int num)
void Swap4BERange (unsigned long *i, int num)
void Swap8BERange (char *c, int num)
void Swap8BERange (double *d, int num)
void SwapWrite2BERange (char *c, int num, FILE *fp)
void SwapWrite2BERange (short *i, int num, FILE *fp)
void SwapWrite4BERange (char *c, int num, FILE *fp)
void SwapWrite4BERange (float *p, int num, FILE *fp)
void SwapWrite4BERange (int *i, int num, FILE *fp)
void SwapWrite4BERange (unsigned long *i, int num, FILE *fp)
void SwapWrite8BERange (char *c, int num, FILE *fp)
void SwapWrite8BERange (double *d, int num, FILE *fp)
void SwapWrite2BERange (char *c, int num, ostream *fp)
void SwapWrite2BERange (short *i, int num, ostream *fp)
void SwapWrite4BERange (char *c, int num, ostream *fp)
void SwapWrite4BERange (float *p, int num, ostream *fp)
void SwapWrite4BERange (int *i, int num, ostream *fp)
void SwapWrite4BERange (unsigned long *i, int num, ostream *fp)
void SwapWrite8BERange (char *c, int num, ostream *fp)
void SwapWrite8BERange (double *d, int num, ostream *fp)

Protected Methods

 vtkByteSwap ()
 ~vtkByteSwap ()

Detailed Description

perform machine dependent byte swapping.

Date:
2001/11/15 21:33:56
Revision:
1.49

vtkByteSwap is used by other classes to perform machine dependent byte swapping. Byte swapping is often used when reading or writing binary files.

Tests:
vtkByteSwap (Tests)

Definition at line 60 of file vtkByteSwap.h.

Constructor & Destructor Documentation

vtkByteSwap::vtkByteSwap (    )  [inline, protected]
 

Definition at line 247 of file vtkByteSwap.h.

vtkByteSwap::~vtkByteSwap (    )  [inline, protected]
 

Definition at line 248 of file vtkByteSwap.h.

Member Function Documentation

vtkByteSwap* vtkByteSwap::New (    )  [static]
 

Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

Reimplemented from vtkObject.

virtual const char* vtkByteSwap::GetClassName (    )  [virtual]
 

Return the class name as a string. This method is defined in all subclasses of vtkObject with the vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkObject.

int vtkByteSwap::IsTypeOf (  const char *    type )  [static]
 

Return 1 if this class type is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkObject.

virtual int vtkByteSwap::IsA (  const char *    type )  [virtual]
 

Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkObject.

vtkByteSwap* vtkByteSwap::SafeDownCast (  vtkObject *    o )  [static]
 

Will cast the supplied object to vtkObject* is this is a safe operation (i.e., a safe downcast); otherwise NULL is returned. This method is defined in all subclasses of vtkObject with the vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkObject.

void vtkByteSwap::Swap2LE (  short *    s )  [static]
 

Swap 2 byte word to be LE.

void vtkByteSwap::Swap2LE (  unsigned short *    s )  [static]
 

Swap 2 byte word to be LE.

void vtkByteSwap::Swap4LE (  char *    c )  [static]
 

Swap four byte word to be LE.

Referenced by Swap4LE().

void vtkByteSwap::Swap4LE (  float *    p )  [inline, static]
 

Swap four byte word to be LE.

Definition at line 75 of file vtkByteSwap.h.

void vtkByteSwap::Swap4LE (  int *    i )  [inline, static]
 

Swap four byte word to be LE.

Definition at line 76 of file vtkByteSwap.h.

void vtkByteSwap::Swap4LE (  unsigned long *    i )  [inline, static]
 

Swap four byte word to be LE.

Definition at line 77 of file vtkByteSwap.h.

void vtkByteSwap::Swap4LE (  long *    i )  [inline, static]
 

Swap four byte word to be LE.

Definition at line 78 of file vtkByteSwap.h.

void vtkByteSwap::Swap8LE (  char *    c )  [static]
 

Swap eight byte word to be LE. Currently implemented for doubles, but will be necessary for 64bit integers? 16bit chars?

Referenced by Swap8LE().

void vtkByteSwap::Swap8LE (  double *    d )  [inline, static]
 

Swap eight byte word to be LE. Currently implemented for doubles, but will be necessary for 64bit integers? 16bit chars?

Definition at line 85 of file vtkByteSwap.h.

void vtkByteSwap::Swap2LERange (  char *    c,
int    num
)  [static]
 

Swap bunch of bytes to LE. Num is the number of two byte words to swap.

Referenced by Swap2LERange().

void vtkByteSwap::Swap2LERange (  short *    i,
int    num
)  [inline, static]
 

Swap bunch of bytes to LE. Num is the number of two byte words to swap.

Definition at line 92 of file vtkByteSwap.h.

void vtkByteSwap::Swap4LERange (  char *    c,
int    num
)  [static]
 

Swap bunch of bytes to be LE. Num is the number of four byte words to swap.

Referenced by Swap4LERange().

void vtkByteSwap::Swap4LERange (  unsigned char *    c,
int    num
)  [inline, static]
 

Swap bunch of bytes to be LE. Num is the number of four byte words to swap.

Definition at line 100 of file vtkByteSwap.h.

void vtkByteSwap::Swap4LERange (  float *    p,
int    num
)  [inline, static]
 

Swap bunch of bytes to be LE. Num is the number of four byte words to swap.

Definition at line 102 of file vtkByteSwap.h.

void vtkByteSwap::Swap4LERange (  int *    i,
int    num
)  [inline, static]
 

Swap bunch of bytes to be LE. Num is the number of four byte words to swap.

Definition at line 104 of file vtkByteSwap.h.

void vtkByteSwap::Swap4LERange (  unsigned long *    i,
int    num
)  [inline, static]
 

Swap bunch of bytes to be LE. Num is the number of four byte words to swap.

Definition at line 106 of file vtkByteSwap.h.

void vtkByteSwap::Swap8LERange (  char *    c,
int    num
)  [static]
 

Swap bunch of bytes to be LE. Num is the number of eight byte words to swap. Currently implemented for doubles...

Referenced by Swap8LERange().

void vtkByteSwap::Swap8LERange (  double *    d,
int    num
)  [inline, static]
 

Swap bunch of bytes to be LE. Num is the number of eight byte words to swap. Currently implemented for doubles...

Definition at line 114 of file vtkByteSwap.h.

void vtkByteSwap::Swap2BE (  short *    s )  [static]
 

Swap 2 byte word to BE.

void vtkByteSwap::Swap2BE (  unsigned short *    s )  [static]
 

Swap 2 byte word to BE.

void vtkByteSwap::Swap4BE (  char *    c )  [static]
 

For writing, swap four byte word to be BE. For reading, swap four byte word from BE to machine's internal representation.

Referenced by Swap4BE().

void vtkByteSwap::Swap4BE (  float *    p )  [inline, static]
 

For writing, swap four byte word to be BE. For reading, swap four byte word from BE to machine's internal representation.

Definition at line 128 of file vtkByteSwap.h.

void vtkByteSwap::Swap4BE (  int *    i )  [inline, static]
 

For writing, swap four byte word to be BE. For reading, swap four byte word from BE to machine's internal representation.

Definition at line 129 of file vtkByteSwap.h.

void vtkByteSwap::Swap4BE (  unsigned long *    i )  [inline, static]
 

For writing, swap four byte word to be BE. For reading, swap four byte word from BE to machine's internal representation.

Definition at line 130 of file vtkByteSwap.h.

void vtkByteSwap::Swap8BE (  char *    c )  [static]
 

For writing, swap eight byte word to be BE. For reading, swap eight byte word from BE to machine's internal representation.

Referenced by Swap8BE().

void vtkByteSwap::Swap8BE (  double *    d )  [inline, static]
 

For writing, swap eight byte word to be BE. For reading, swap eight byte word from BE to machine's internal representation.

Definition at line 137 of file vtkByteSwap.h.

void vtkByteSwap::Swap2BERange (  char *    c,
int    num
)  [static]
 

Swap bunch of bytes to BE. Num is the number of two byte words to swap.

Referenced by Swap2BERange().

void vtkByteSwap::Swap2BERange (  short *    i,
int    num
)  [inline, static]
 

Swap bunch of bytes to BE. Num is the number of two byte words to swap.

Definition at line 144 of file vtkByteSwap.h.

void vtkByteSwap::Swap4BERange (  char *    c,
int    num
)  [static]
 

Swap bunch of bytes to be BE. Num is the number of four byte words to swap.

Referenced by Swap4BERange().

void vtkByteSwap::Swap4BERange (  float *    p,
int    num
)  [inline, static]
 

Swap bunch of bytes to be BE. Num is the number of four byte words to swap.

Definition at line 152 of file vtkByteSwap.h.

void vtkByteSwap::Swap4BERange (  int *    i,
int    num
)  [inline, static]
 

Swap bunch of bytes to be BE. Num is the number of four byte words to swap.

Definition at line 154 of file vtkByteSwap.h.

void vtkByteSwap::Swap4BERange (  unsigned long *    i,
int    num
)  [inline, static]
 

Swap bunch of bytes to be BE. Num is the number of four byte words to swap.

Definition at line 156 of file vtkByteSwap.h.

void vtkByteSwap::Swap8BERange (  char *    c,
int    num
)  [static]
 

Swap bunch of bytes to be BE. Num is the number of eight byte words to swap.

Referenced by Swap8BERange().

void vtkByteSwap::Swap8BERange (  double *    d,
int    num
)  [inline, static]
 

Swap bunch of bytes to be BE. Num is the number of eight byte words to swap.

Definition at line 169 of file vtkByteSwap.h.

void vtkByteSwap::SwapWrite2BERange (  char *    c,
int    num,
FILE *    fp
)  [static]
 

Swap bunch of bytes to BE. Num is the number of two byte words to swap. The results are written out to file to prevent having to keep the swapped copy in memory.

Referenced by SwapWrite2BERange().

void vtkByteSwap::SwapWrite2BERange (  short *    i,
int    num,
FILE *    fp
)  [inline, static]
 

Swap bunch of bytes to BE. Num is the number of two byte words to swap. The results are written out to file to prevent having to keep the swapped copy in memory.

Definition at line 178 of file vtkByteSwap.h.

void vtkByteSwap::SwapWrite4BERange (  char *    c,
int    num,
FILE *    fp
)  [static]
 

Swap bunch of bytes to BE. Num is the number of four byte words to swap. The results are written out to file to prevent having to keep the swapped copy in memory.

Referenced by SwapWrite4BERange().

void vtkByteSwap::SwapWrite4BERange (  float *    p,
int    num,
FILE *    fp
)  [inline, static]
 

Swap bunch of bytes to BE. Num is the number of four byte words to swap. The results are written out to file to prevent having to keep the swapped copy in memory.

Definition at line 187 of file vtkByteSwap.h.

void vtkByteSwap::SwapWrite4BERange (  int *    i,
int    num,
FILE *    fp
)  [inline, static]
 

Swap bunch of bytes to BE. Num is the number of four byte words to swap. The results are written out to file to prevent having to keep the swapped copy in memory.

Definition at line 189 of file vtkByteSwap.h.

void vtkByteSwap::SwapWrite4BERange (  unsigned long *    i,
int    num,
FILE *    fp
)  [inline, static]
 

Swap bunch of bytes to BE. Num is the number of four byte words to swap. The results are written out to file to prevent having to keep the swapped copy in memory.

Definition at line 191 of file vtkByteSwap.h.

void vtkByteSwap::SwapWrite8BERange (  char *    c,
int    num,
FILE *    fp
)  [static]
 

Swap bunch of bytes to BE. Num is the number of eight byte words to swap. The results are written out to file to prevent having to keep the swapped copy in memory. Implemented for doubles for now.

Referenced by SwapWrite8BERange().

void vtkByteSwap::SwapWrite8BERange (  double *    d,
int    num,
FILE *    fp
)  [inline, static]
 

Swap bunch of bytes to BE. Num is the number of four byte words to swap. The results are written out to file to prevent having to keep the swapped copy in memory.

Definition at line 203 of file vtkByteSwap.h.

void vtkByteSwap::SwapWrite2BERange (  char *    c,
int    num,
ostream *    fp
)  [static]
 

Swap bunch of bytes to BE. Num is the number of two byte words to swap. The results are written out to stream to prevent having to keep the swapped copy in memory.

void vtkByteSwap::SwapWrite2BERange (  short *    i,
int    num,
ostream *    fp
)  [inline, static]
 

Swap bunch of bytes to BE. Num is the number of two byte words to swap. The results are written out to stream to prevent having to keep the swapped copy in memory.

Definition at line 212 of file vtkByteSwap.h.

void vtkByteSwap::SwapWrite4BERange (  char *    c,
int    num,
ostream *    fp
)  [static]
 

Swap bunch of bytes to BE. Num is the number of four byte words to swap. The results are written out to stream to prevent having to keep the swapped copy in memory.

void vtkByteSwap::SwapWrite4BERange (  float *    p,
int    num,
ostream *    fp
)  [inline, static]
 

Swap bunch of bytes to BE. Num is the number of four byte words to swap. The results are written out to stream to prevent having to keep the swapped copy in memory.

Definition at line 221 of file vtkByteSwap.h.

void vtkByteSwap::SwapWrite4BERange (  int *    i,
int    num,
ostream *    fp
)  [inline, static]
 

Swap bunch of bytes to BE. Num is the number of four byte words to swap. The results are written out to stream to prevent having to keep the swapped copy in memory.

Definition at line 223 of file vtkByteSwap.h.

void vtkByteSwap::SwapWrite4BERange (  unsigned long *    i,
int    num,
ostream *    fp
)  [inline, static]
 

Swap bunch of bytes to BE. Num is the number of four byte words to swap. The results are written out to stream to prevent having to keep the swapped copy in memory.

Definition at line 225 of file vtkByteSwap.h.

void vtkByteSwap::SwapWrite8BERange (  char *    c,
int    num,
ostream *    fp
)  [static]
 

Swap bunch of bytes to BE. Num is the number of eight byte words to swap. The results are written out to stream to prevent having to keep the swapped copy in memory.

void vtkByteSwap::SwapWrite8BERange (  double *    d,
int    num,
ostream *    fp
)  [inline, static]
 

Swap bunch of bytes to BE. Num is the number of four byte words to swap. The results are written out to stream to prevent having to keep the swapped copy in memory.

Definition at line 237 of file vtkByteSwap.h.

void vtkByteSwap::SwapVoidRange (  void *    buffer,
int    numWords,
int    wordSize
)  [static]
 

Swaps the bytes of a buffer. Uses an arbitrary word size, but assumes the word size is divisible by two.

The documentation for this class was generated from the following file:
Generated on Thu Mar 28 14:27:30 2002 for VTK by doxygen1.2.11.1 written by Dimitri van Heesch, © 1997-2001