VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkBase64InputStream Class Reference

Reads base64-encoded input from a stream. More...

#include <vtkBase64InputStream.h>

Inheritance diagram for vtkBase64InputStream:
[legend]
Collaboration diagram for vtkBase64InputStream:
[legend]

Public Types

typedef vtkInputStream Superclass
 
- Public Types inherited from vtkInputStream
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...
 
vtkBase64InputStreamNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 
void StartReading ()
 Called after the stream position has been set by the caller, but before any Seek or Read calls. More...
 
int Seek (vtkTypeInt64 offset)
 Seek to the given offset in the input data. More...
 
size_t Read (void *data, size_t length)
 Read input data of the given length. More...
 
void EndReading ()
 Called after all desired calls to Seek and Read have been made. More...
 
- Public Member Functions inherited from vtkInputStream
vtkInputStreamNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void SetStream (istream *)
 Get/Set the real input stream. More...
 
virtual istream * GetStream ()
 Get/Set the real input stream. More...
 
- 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 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...
 
vtkCommandGetCommand (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 int IsTypeOf (const char *type)
 
static vtkBase64InputStreamSafeDownCast (vtkObjectBase *o)
 
static vtkBase64InputStreamNew ()
 
- Static Public Member Functions inherited from vtkInputStream
static int IsTypeOf (const char *type)
 
static vtkInputStreamSafeDownCast (vtkObjectBase *o)
 
static vtkInputStreamNew ()
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 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 vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkBase64InputStream ()
 
 ~vtkBase64InputStream ()
 
int DecodeTriplet (unsigned char &c0, unsigned char &c1, unsigned char &c2)
 
- Protected Member Functions inherited from vtkInputStream
 vtkInputStream ()
 
 ~vtkInputStream ()
 
size_t ReadStream (char *data, size_t length)
 
- 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 &)
 

Protected Attributes

int BufferLength
 
unsigned char Buffer [2]
 
- Protected Attributes inherited from vtkInputStream
istream * Stream
 
vtkTypeInt64 StreamStartPosition
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

Reads base64-encoded input from a stream.

vtkBase64InputStream implements base64 decoding with the vtkInputStream interface.

Definition at line 29 of file vtkBase64InputStream.h.

Member Typedef Documentation

Definition at line 32 of file vtkBase64InputStream.h.

Constructor & Destructor Documentation

vtkBase64InputStream::vtkBase64InputStream ( )
protected
vtkBase64InputStream::~vtkBase64InputStream ( )
protected

Member Function Documentation

static int vtkBase64InputStream::IsTypeOf ( const char *  type)
static
virtual int vtkBase64InputStream::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 vtkInputStream.

static vtkBase64InputStream* vtkBase64InputStream::SafeDownCast ( vtkObjectBase o)
static
virtual vtkObjectBase* vtkBase64InputStream::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkInputStream.

vtkBase64InputStream* vtkBase64InputStream::NewInstance ( ) const
static vtkBase64InputStream* vtkBase64InputStream::New ( )
static
void vtkBase64InputStream::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
virtual

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

void vtkBase64InputStream::StartReading ( )
virtual

Called after the stream position has been set by the caller, but before any Seek or Read calls.

The stream position should not be adjusted by the caller until after an EndReading call.

Reimplemented from vtkInputStream.

int vtkBase64InputStream::Seek ( vtkTypeInt64  offset)
virtual

Seek to the given offset in the input data.

Returns 1 for success, 0 for failure.

Reimplemented from vtkInputStream.

size_t vtkBase64InputStream::Read ( void *  data,
size_t  length 
)
virtual

Read input data of the given length.

Returns amount actually read.

Reimplemented from vtkInputStream.

void vtkBase64InputStream::EndReading ( )
virtual

Called after all desired calls to Seek and Read have been made.

After this call, the caller is free to change the position of the stream. Additional reads should not be done until after another call to StartReading.

Reimplemented from vtkInputStream.

int vtkBase64InputStream::DecodeTriplet ( unsigned char &  c0,
unsigned char &  c1,
unsigned char &  c2 
)
protected

Member Data Documentation

int vtkBase64InputStream::BufferLength
protected

Definition at line 68 of file vtkBase64InputStream.h.

unsigned char vtkBase64InputStream::Buffer[2]
protected

Definition at line 69 of file vtkBase64InputStream.h.


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