base64 encode and decode utilities. More...

#include <vtkBase64Utilities.h>

Inheritance diagram for vtkBase64Utilities:

Collaboration diagram for vtkBase64Utilities:

Public Types
typedef vtkObject	Superclass

Public Member Functions
virtual int	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class. More...

vtkBase64Utilities *	NewInstance () const

Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)

virtual void	DebugOn ()
	Turn debugging output on. More...

virtual void	DebugOff ()
	Turn debugging output off. More...

bool	GetDebug ()
	Get the value of the debug flag. More...

void	SetDebug (bool debugFlag)
	Set the value of the debug flag. More...

virtual void	Modified ()
	Update the modification time for this object. More...

virtual vtkMTimeType	GetMTime ()
	Return this object's modified time. More...

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses. More...

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

int	HasObserver (unsigned long event)

int	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. More...

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObservers (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

int	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

int	HasObserver (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

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

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

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

int	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not. More...

int	InvokeEvent (const char event, void callData)
	This method invokes an event and return whether the event was aborted or not. More...

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string. More...

virtual void	Delete ()
	Delete a VTK object. More...

virtual void	FastDelete ()
	Delete a reference to this object. More...

void	InitializeObjectBase ()

void	Print (ostream &os)
	Print an object to an ostream. More...

virtual void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object). More...

virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object). More...

int	GetReferenceCount ()
	Return the current reference count of this object. More...

void	SetReferenceCount (int)
	Sets the reference count. More...

void	PrintRevisions (ostream &)
	Legacy. More...

virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...

virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...

Static Public Member Functions
static vtkBase64Utilities *	New ()

static int	IsTypeOf (const char *type)

static vtkBase64Utilities *	SafeDownCast (vtkObjectBase *o)

static void	EncodeTriplet (unsigned char i0, unsigned char i1, unsigned char i2, unsigned char o0, unsigned char o1, unsigned char o2, unsigned char o3)
	Encode 3 bytes into 4 bytes. More...

static void	EncodePair (unsigned char i0, unsigned char i1, unsigned char o0, unsigned char o1, unsigned char o2, unsigned char o3)
	Encode 2 bytes into 4 bytes. More...

static void	EncodeSingle (unsigned char i0, unsigned char o0, unsigned char o1, unsigned char o2, unsigned char o3)
	Encode 1 byte into 4 bytes. More...

static unsigned long	Encode (const unsigned char input, unsigned long length, unsigned char output, int mark_end=0)
	Encode 'length' bytes from the input buffer and store the encoded stream into the output buffer. More...

static int	DecodeTriplet (unsigned char i0, unsigned char i1, unsigned char i2, unsigned char i3, unsigned char o0, unsigned char o1, unsigned char *o2)
	Decode 4 bytes into 3 bytes. More...

static unsigned long	Decode (const unsigned char input, unsigned long length, unsigned char output, unsigned long max_input_length=0)
	Decode bytes from the input buffer and store the decoded stream into the output buffer until 'length' bytes have been decoded. More...

static size_t	DecodeSafely (const unsigned char input, size_t inputLen, unsigned char output, size_t outputLen)
	Decode 4 bytes at a time from the input buffer and store the decoded stream into the output buffer. More...

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

static void	BreakOnError ()
	This method is called when vtkErrorMacro executes. More...

static void	SetGlobalWarningDisplay (int val)
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static int	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

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

static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkBase64Utilities ()

	~vtkBase64Utilities ()

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=NULL)
	These methods allow a command to exclusively grab all events. More...

void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events. More...

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	CollectRevisions (ostream &)

virtual void	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Additional Inherited Members
Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Detailed Description

base64 encode and decode utilities.

vtkBase64Utilities implements base64 encoding and decoding.

Tests:: vtkBase64Utilities (Tests)

Definition at line 31 of file vtkBase64Utilities.h.

Member Typedef Documentation

typedef vtkObject vtkBase64Utilities::Superclass

Definition at line 35 of file vtkBase64Utilities.h.

Constructor & Destructor Documentation

vtkBase64Utilities::vtkBase64Utilities ( )

inlineprotected

Definition at line 130 of file vtkBase64Utilities.h.

vtkBase64Utilities::~vtkBase64Utilities ( )

inlineprotected

Definition at line 131 of file vtkBase64Utilities.h.

Member Function Documentation

static vtkBase64Utilities* vtkBase64Utilities::New ( )

static

static int vtkBase64Utilities::IsTypeOf ( const char * type )

static

virtual int vtkBase64Utilities::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.

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

static

virtual vtkObjectBase* vtkBase64Utilities::NewInstanceInternal ( ) const

protectedvirtual

vtkBase64Utilities* vtkBase64Utilities::NewInstance ( ) const

static void vtkBase64Utilities::EncodeTriplet	(	unsigned char	i0,
		unsigned char	i1,
		unsigned char	i2,
		unsigned char *	o0,
		unsigned char *	o1,
		unsigned char *	o2,
		unsigned char *	o3
	)

static

Encode 3 bytes into 4 bytes.

static void vtkBase64Utilities::EncodePair	(	unsigned char	i0,
		unsigned char	i1,
		unsigned char *	o0,
		unsigned char *	o1,
		unsigned char *	o2,
		unsigned char *	o3
	)

static

Encode 2 bytes into 4 bytes.

static void vtkBase64Utilities::EncodeSingle	(	unsigned char	i0,
		unsigned char *	o0,
		unsigned char *	o1,
		unsigned char *	o2,
		unsigned char *	o3
	)

static

Encode 1 byte into 4 bytes.

static unsigned long vtkBase64Utilities::Encode	(	const unsigned char *	input,
		unsigned long	length,
		unsigned char *	output,
		int	mark_end = `0`
	)

static

Encode 'length' bytes from the input buffer and store the encoded stream into the output buffer.

Return the length of the encoded stream. Note that the output buffer must be allocated by the caller (length * 1.5 should be a safe estimate). If 'mark_end' is true then an extra set of 4 bytes is added to the end of the stream if the input is a multiple of 3 bytes. These bytes are invalid chars and therefore they will stop the decoder thus enabling the caller to decode a stream without actually knowing how much data to expect (if the input is not a multiple of 3 bytes then the extra padding needed to complete the encode 4 bytes will stop the decoding anyway).

static int vtkBase64Utilities::DecodeTriplet	(	unsigned char	i0,
		unsigned char	i1,
		unsigned char	i2,
		unsigned char	i3,
		unsigned char *	o0,
		unsigned char *	o1,
		unsigned char *	o2
	)

static

Decode 4 bytes into 3 bytes.

Return the number of bytes actually decoded (0 to 3, inclusive).

static unsigned long vtkBase64Utilities::Decode	(	const unsigned char *	input,
		unsigned long	length,
		unsigned char *	output,
		unsigned long	max_input_length = `0`
	)

static

Decode bytes from the input buffer and store the decoded stream into the output buffer until 'length' bytes have been decoded.

Return the real length of the decoded stream (which should be equal to 'length'). Note that the output buffer must be allocated by the caller. If 'max_input_length' is not 0, then it specifies the number of encoded bytes that should be at most read from the input buffer. In that case the 'length' parameter is ignored. This enables the caller to decode a stream without actually knowing how much decoded data to expect (of course, the buffer must be large enough).

Deprecated:: : This method can easily overrun its buffers, use DecodeSafely.

static size_t vtkBase64Utilities::DecodeSafely	(	const unsigned char *	input,
		size_t	inputLen,
		unsigned char *	output,
		size_t	outputLen
	)

static

Decode 4 bytes at a time from the input buffer and store the decoded stream into the output buffer.

The required output buffer size must be determined and allocated by the caller. The needed output space is always less than the input buffer size, so a good first order approximation is to allocate the same size. Base64 encoding is about 4/3 overhead, so a tighter bound is possible. Return the number of bytes atually placed into the output buffer.

The documentation for this class was generated from the following file:

/home/demarle/Builds/VTK/release/Utilities/Doxygen/dox/IO/Core/vtkBase64Utilities.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation