vtkByteSwap Class Reference

perform machine dependent byte swapping More...

#include <vtkByteSwap.h>

Inheritance diagram for vtkByteSwap:

Collaboration diagram for vtkByteSwap:

Public Types
typedef vtkObject	Superclass

Public Member Functions
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.
vtkByteSwap *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
	VTK_BYTE_SWAP_DECL (float)
	VTK_BYTE_SWAP_DECL (double)
	VTK_BYTE_SWAP_DECL (char)
	VTK_BYTE_SWAP_DECL (short)
	VTK_BYTE_SWAP_DECL (int)
	VTK_BYTE_SWAP_DECL (long)
	VTK_BYTE_SWAP_DECL (long long)
	VTK_BYTE_SWAP_DECL (signed char)
	VTK_BYTE_SWAP_DECL (unsigned char)
	VTK_BYTE_SWAP_DECL (unsigned short)
	VTK_BYTE_SWAP_DECL (unsigned int)
	VTK_BYTE_SWAP_DECL (unsigned long)
	VTK_BYTE_SWAP_DECL (unsigned long long)
Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)
virtual void	DebugOn ()
	Turn debugging output on.
virtual void	DebugOff ()
	Turn debugging output off.
bool	GetDebug ()
	Get the value of the debug flag.
void	SetDebug (bool debugFlag)
	Set the value of the debug flag.
virtual void	Modified ()
	Update the modification time for this object.
virtual vtkMTimeType	GetMTime ()
	Return this object's modified time.
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
void	RemoveObserver (unsigned long tag)
void	RemoveObservers (unsigned long event)
void	RemoveObservers (const char *event)
void	RemoveAllObservers ()
vtkTypeBool	HasObserver (unsigned long event)
vtkTypeBool	HasObserver (const char *event)
int	InvokeEvent (unsigned long event)
int	InvokeEvent (const char *event)
unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
unsigned long	AddObserver (const char *event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObservers (const char *event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkTypeBool	HasObserver (const char *event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events.
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events.
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
	Allow user to set the AbortFlagOn() with the return value of the callback method.
int	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not.
int	InvokeEvent (const char *event, void *callData)
	This method invokes an event and return whether the event was aborted or not.
Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string.
virtual vtkTypeBool	IsA (const char *name)
	Return 1 if this class is the same type of (or a subclass of) the named class.
virtual vtkIdType	GetNumberOfGenerationsFromBase (const char *name)
	Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
virtual void	Delete ()
	Delete a VTK object.
virtual void	FastDelete ()
	Delete a reference to this object.
void	InitializeObjectBase ()
void	Print (ostream &os)
	Print an object to an ostream.
virtual void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object).
virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object).
int	GetReferenceCount ()
	Return the current reference count of this object.
void	SetReferenceCount (int)
	Sets the reference count.
bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space.
virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.
virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.

Static Public Member Functions
static vtkByteSwap *	New ()
static vtkTypeBool	IsTypeOf (const char *type)
static vtkByteSwap *	SafeDownCast (vtkObjectBase *o)
static void	SwapVoidRange (void *buffer, size_t numWords, size_t wordSize)
	Swaps the bytes of a buffer.
static void	Swap2LE (void *p)
	Swap 2, 4, or 8 bytes for storage as Little Endian.
static void	Swap4LE (void *p)
	Swap 2, 4, or 8 bytes for storage as Little Endian.
static void	Swap8LE (void *p)
	Swap 2, 4, or 8 bytes for storage as Little Endian.
static void	Swap2LERange (void *p, size_t num)
	Swap a block of 2-, 4-, or 8-byte segments for storage as Little Endian.
static void	Swap4LERange (void *p, size_t num)
	Swap a block of 2-, 4-, or 8-byte segments for storage as Little Endian.
static void	Swap8LERange (void *p, size_t num)
	Swap a block of 2-, 4-, or 8-byte segments for storage as Little Endian.
static bool	SwapWrite2LERange (void const *p, size_t num, FILE *f)
	Swap a block of 2-, 4-, or 8-byte segments for storage as Little Endian.
static bool	SwapWrite4LERange (void const *p, size_t num, FILE *f)
	Swap a block of 2-, 4-, or 8-byte segments for storage as Little Endian.
static bool	SwapWrite8LERange (void const *p, size_t num, FILE *f)
	Swap a block of 2-, 4-, or 8-byte segments for storage as Little Endian.
static void	SwapWrite2LERange (void const *p, size_t num, ostream *os)
	Swap a block of 2-, 4-, or 8-byte segments for storage as Little Endian.
static void	SwapWrite4LERange (void const *p, size_t num, ostream *os)
	Swap a block of 2-, 4-, or 8-byte segments for storage as Little Endian.
static void	SwapWrite8LERange (void const *p, size_t num, ostream *os)
	Swap a block of 2-, 4-, or 8-byte segments for storage as Little Endian.
static void	Swap2BE (void *p)
	Swap 2, 4, or 8 bytes for storage as Big Endian.
static void	Swap4BE (void *p)
	Swap 2, 4, or 8 bytes for storage as Big Endian.
static void	Swap8BE (void *p)
	Swap 2, 4, or 8 bytes for storage as Big Endian.
static void	Swap2BERange (void *p, size_t num)
	Swap a block of 2-, 4-, or 8-byte segments for storage as Big Endian.
static void	Swap4BERange (void *p, size_t num)
	Swap a block of 2-, 4-, or 8-byte segments for storage as Big Endian.
static void	Swap8BERange (void *p, size_t num)
	Swap a block of 2-, 4-, or 8-byte segments for storage as Big Endian.
static bool	SwapWrite2BERange (void const *p, size_t num, FILE *f)
	Swap a block of 2-, 4-, or 8-byte segments for storage as Big Endian.
static bool	SwapWrite4BERange (void const *p, size_t num, FILE *f)
	Swap a block of 2-, 4-, or 8-byte segments for storage as Big Endian.
static bool	SwapWrite8BERange (void const *p, size_t num, FILE *f)
	Swap a block of 2-, 4-, or 8-byte segments for storage as Big Endian.
static void	SwapWrite2BERange (void const *p, size_t num, ostream *os)
	Swap a block of 2-, 4-, or 8-byte segments for storage as Big Endian.
static void	SwapWrite4BERange (void const *p, size_t num, ostream *os)
	Swap a block of 2-, 4-, or 8-byte segments for storage as Big Endian.
static void	SwapWrite8BERange (void const *p, size_t num, ostream *os)
	Swap a block of 2-, 4-, or 8-byte segments for storage as Big Endian.
Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
static void	BreakOnError ()
	This method is called when vtkErrorMacro executes.
static void	SetGlobalWarningDisplay (int val)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static int	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)
	Return 1 if this class type is the same type of (or a subclass of) the named class.
static vtkIdType	GetNumberOfGenerationsFromBaseType (const char *name)
	Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.
static bool	GetUsingMemkind ()
	A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space.

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkByteSwap ()
	~vtkByteSwap () override
Protected Member Functions inherited from vtkObject
	vtkObject ()
	~vtkObject () override
void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
void	InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
	These methods allow a command to exclusively grab all events.
void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events.
Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()
virtual	~vtkObjectBase ()
virtual void	RegisterInternal (vtkObjectBase *, vtkTypeBool check)
virtual void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)
virtual void	ReportReferences (vtkGarbageCollector *)
	vtkObjectBase (const vtkObjectBase &)
void	operator= (const vtkObjectBase &)

Additional Inherited Members
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()
static vtkReallocingFunction	GetCurrentReallocFunction ()
static vtkFreeingFunction	GetCurrentFreeFunction ()
static vtkFreeingFunction	GetAlternateFreeFunction ()
Protected Attributes inherited from vtkObject
bool	Debug
vtkTimeStamp	MTime
vtkSubjectHelper *	SubjectHelper
Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	ReferenceCount
vtkWeakPointerBase **	WeakPointers

Detailed Description

perform machine dependent byte swapping

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

Definition at line 30 of file vtkByteSwap.h.

Member Typedef Documentation

Superclass

typedef vtkObject vtkByteSwap::Superclass

Definition at line 34 of file vtkByteSwap.h.

Constructor & Destructor Documentation

vtkByteSwap()

vtkByteSwap::vtkByteSwap ( )

protected

~vtkByteSwap()

vtkByteSwap::~vtkByteSwap ( )

overrideprotected

Member Function Documentation

New()

static vtkByteSwap * vtkByteSwap::New ( )

static

IsTypeOf()

static vtkTypeBool vtkByteSwap::IsTypeOf ( const char *  type )

static

IsA()

virtual vtkTypeBool vtkByteSwap::IsA ( const char *  name )

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 vtkObjectBase.

SafeDownCast()

static vtkByteSwap * vtkByteSwap::SafeDownCast ( vtkObjectBase *  o )

static

NewInstanceInternal()

virtual vtkObjectBase * vtkByteSwap::NewInstanceInternal ( ) const

protectedvirtual

NewInstance()

vtkByteSwap * vtkByteSwap::NewInstance

(

)

const

PrintSelf()

void vtkByteSwap::PrintSelf ( ostream &  os, vtkIndent  indent  )

overridevirtual

Methods invoked by print to print information about the object including superclasses.

Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkObjectBase.

VTK_BYTE_SWAP_DECL() [1/13]

vtkByteSwap::VTK_BYTE_SWAP_DECL

(

float

)

VTK_BYTE_SWAP_DECL() [2/13]

vtkByteSwap::VTK_BYTE_SWAP_DECL

(

double

)

VTK_BYTE_SWAP_DECL() [3/13]

vtkByteSwap::VTK_BYTE_SWAP_DECL

(

char

)

VTK_BYTE_SWAP_DECL() [4/13]

vtkByteSwap::VTK_BYTE_SWAP_DECL

(

short

)

VTK_BYTE_SWAP_DECL() [5/13]

vtkByteSwap::VTK_BYTE_SWAP_DECL

(

int

)

VTK_BYTE_SWAP_DECL() [6/13]

vtkByteSwap::VTK_BYTE_SWAP_DECL

(

long

)

VTK_BYTE_SWAP_DECL() [7/13]

vtkByteSwap::VTK_BYTE_SWAP_DECL

(

long long

)

VTK_BYTE_SWAP_DECL() [8/13]

vtkByteSwap::VTK_BYTE_SWAP_DECL

(

signed char

)

VTK_BYTE_SWAP_DECL() [9/13]

vtkByteSwap::VTK_BYTE_SWAP_DECL

(

unsigned char

)

VTK_BYTE_SWAP_DECL() [10/13]

vtkByteSwap::VTK_BYTE_SWAP_DECL

(

unsigned short

)

VTK_BYTE_SWAP_DECL() [11/13]

vtkByteSwap::VTK_BYTE_SWAP_DECL

(

unsigned int

)

VTK_BYTE_SWAP_DECL() [12/13]

vtkByteSwap::VTK_BYTE_SWAP_DECL

(

unsigned long

)

VTK_BYTE_SWAP_DECL() [13/13]

vtkByteSwap::VTK_BYTE_SWAP_DECL

(

unsigned long long

)

Swap2LE()

static void vtkByteSwap::Swap2LE ( void *  p )

static

Swap 2, 4, or 8 bytes for storage as Little Endian.

Swap4LE()

static void vtkByteSwap::Swap4LE ( void *  p )

static

Swap 2, 4, or 8 bytes for storage as Little Endian.

Swap8LE()

static void vtkByteSwap::Swap8LE ( void *  p )

static

Swap 2, 4, or 8 bytes for storage as Little Endian.

Swap2LERange()

static void vtkByteSwap::Swap2LERange ( void *  p, size_t  num  )

static

Swap a block of 2-, 4-, or 8-byte segments for storage as Little Endian.

Swap4LERange()

static void vtkByteSwap::Swap4LERange ( void *  p, size_t  num  )

static

Swap a block of 2-, 4-, or 8-byte segments for storage as Little Endian.

Swap8LERange()

static void vtkByteSwap::Swap8LERange ( void *  p, size_t  num  )

static

Swap a block of 2-, 4-, or 8-byte segments for storage as Little Endian.

SwapWrite2LERange() [1/2]

static bool vtkByteSwap::SwapWrite2LERange ( void const *  p, size_t  num, FILE *  f  )

static

Swap a block of 2-, 4-, or 8-byte segments for storage as Little Endian.

The results are written directly to a file to avoid temporary storage.

SwapWrite4LERange() [1/2]

static bool vtkByteSwap::SwapWrite4LERange ( void const *  p, size_t  num, FILE *  f  )

static

Swap a block of 2-, 4-, or 8-byte segments for storage as Little Endian.

The results are written directly to a file to avoid temporary storage.

SwapWrite8LERange() [1/2]

static bool vtkByteSwap::SwapWrite8LERange ( void const *  p, size_t  num, FILE *  f  )

static

Swap a block of 2-, 4-, or 8-byte segments for storage as Little Endian.

The results are written directly to a file to avoid temporary storage.

SwapWrite2LERange() [2/2]

static void vtkByteSwap::SwapWrite2LERange ( void const *  p, size_t  num, ostream *  os  )

static

Swap a block of 2-, 4-, or 8-byte segments for storage as Little Endian.

The results are written directly to a file to avoid temporary storage.

SwapWrite4LERange() [2/2]

static void vtkByteSwap::SwapWrite4LERange ( void const *  p, size_t  num, ostream *  os  )

static

Swap a block of 2-, 4-, or 8-byte segments for storage as Little Endian.

The results are written directly to a file to avoid temporary storage.

SwapWrite8LERange() [2/2]

static void vtkByteSwap::SwapWrite8LERange ( void const *  p, size_t  num, ostream *  os  )

static

Swap a block of 2-, 4-, or 8-byte segments for storage as Little Endian.

The results are written directly to a file to avoid temporary storage.

Swap2BE()

static void vtkByteSwap::Swap2BE ( void *  p )

static

Swap 2, 4, or 8 bytes for storage as Big Endian.

Swap4BE()

static void vtkByteSwap::Swap4BE ( void *  p )

static

Swap 2, 4, or 8 bytes for storage as Big Endian.

Swap8BE()

static void vtkByteSwap::Swap8BE ( void *  p )

static

Swap 2, 4, or 8 bytes for storage as Big Endian.

Swap2BERange()

static void vtkByteSwap::Swap2BERange ( void *  p, size_t  num  )

static

Swap a block of 2-, 4-, or 8-byte segments for storage as Big Endian.

Swap4BERange()

static void vtkByteSwap::Swap4BERange ( void *  p, size_t  num  )

static

Swap a block of 2-, 4-, or 8-byte segments for storage as Big Endian.

Swap8BERange()

static void vtkByteSwap::Swap8BERange ( void *  p, size_t  num  )

static

Swap a block of 2-, 4-, or 8-byte segments for storage as Big Endian.

SwapWrite2BERange() [1/2]

static bool vtkByteSwap::SwapWrite2BERange ( void const *  p, size_t  num, FILE *  f  )

static

Swap a block of 2-, 4-, or 8-byte segments for storage as Big Endian.

The results are written directly to a file to avoid temporary storage.

SwapWrite4BERange() [1/2]

static bool vtkByteSwap::SwapWrite4BERange ( void const *  p, size_t  num, FILE *  f  )

static

Swap a block of 2-, 4-, or 8-byte segments for storage as Big Endian.

The results are written directly to a file to avoid temporary storage.

SwapWrite8BERange() [1/2]

static bool vtkByteSwap::SwapWrite8BERange ( void const *  p, size_t  num, FILE *  f  )

static

Swap a block of 2-, 4-, or 8-byte segments for storage as Big Endian.

The results are written directly to a file to avoid temporary storage.

SwapWrite2BERange() [2/2]

static void vtkByteSwap::SwapWrite2BERange ( void const *  p, size_t  num, ostream *  os  )

static

Swap a block of 2-, 4-, or 8-byte segments for storage as Big Endian.

The results are written directly to a file to avoid temporary storage.

SwapWrite4BERange() [2/2]

static void vtkByteSwap::SwapWrite4BERange ( void const *  p, size_t  num, ostream *  os  )

static

Swap a block of 2-, 4-, or 8-byte segments for storage as Big Endian.

The results are written directly to a file to avoid temporary storage.

SwapWrite8BERange() [2/2]

static void vtkByteSwap::SwapWrite8BERange ( void const *  p, size_t  num, ostream *  os  )

static

Swap a block of 2-, 4-, or 8-byte segments for storage as Big Endian.

The results are written directly to a file to avoid temporary storage.

SwapVoidRange()

static void vtkByteSwap::SwapVoidRange ( void *  buffer, size_t  numWords, size_t  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:

• Common/Core/vtkByteSwap.h