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

Wraps a binary input stream with a VTK interface. More...

#include <vtkInputStream.h>

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

Public Types

typedef vtkObject Superclass
- Public Types inherited from vtkObject
typedef vtkObjectBase Superclass

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
virtual void StartReading ()
virtual int Seek (unsigned long offset)
virtual void EndReading ()
virtual void SetStream (istream *)
virtual istream * GetStream ()
virtual unsigned long Read (unsigned char *data, unsigned long length)
unsigned long Read (char *data, unsigned long length)
- Public Member Functions inherited from vtkObject
virtual void DebugOn ()
virtual void DebugOff ()
unsigned char GetDebug ()
void SetDebug (unsigned char debugFlag)
virtual void Modified ()
virtual unsigned long GetMTime ()
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
vtkCommandGetCommand (unsigned long tag)
void RemoveObserver (vtkCommand *)
void RemoveObservers (unsigned long event, vtkCommand *)
void RemoveObservers (const char *event, vtkCommand *)
int HasObserver (unsigned long event, vtkCommand *)
int HasObserver (const char *event, vtkCommand *)
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)
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
int InvokeEvent (unsigned long event, void *callData)
int InvokeEvent (const char *event, void *callData)
int InvokeEvent (unsigned long event)
int InvokeEvent (const char *event)
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
virtual void Delete ()
virtual void FastDelete ()
void Print (ostream &os)
virtual void Register (vtkObjectBase *o)
virtual void UnRegister (vtkObjectBase *o)
void SetReferenceCount (int)
void PrintRevisions (ostream &os)
virtual void PrintHeader (ostream &os, vtkIndent indent)
virtual void PrintTrailer (ostream &os, vtkIndent indent)
int GetReferenceCount ()

Static Public Member Functions

static int IsTypeOf (const char *type)
static vtkInputStreamSafeDownCast (vtkObject *o)
static vtkInputStreamNew ()
- Static Public Member Functions inherited from vtkObject
static void BreakOnError ()
static void SetGlobalWarningDisplay (int val)
static void GlobalWarningDisplayOn ()
static void GlobalWarningDisplayOff ()
static int GetGlobalWarningDisplay ()

Protected Member Functions

 vtkInputStream ()
 ~vtkInputStream ()
- Protected Member Functions inherited from vtkObject
 vtkObject ()
virtual ~vtkObject ()
virtual void RegisterInternal (vtkObjectBase *, int check)
virtual void UnRegisterInternal (vtkObjectBase *, int check)
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
void InternalReleaseFocus ()
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
virtual ~vtkObjectBase ()
virtual void CollectRevisions (ostream &os)
virtual void ReportReferences (vtkGarbageCollector *)
 vtkObjectBase (const vtkObjectBase &)
void operator= (const vtkObjectBase &)

Protected Attributes

istream * Stream
unsigned long StreamStartPosition
- Protected Attributes inherited from vtkObject
unsigned char Debug
vtkTimeStamp MTime
vtkSubjectHelper * SubjectHelper
- Protected Attributes inherited from vtkObjectBase
int ReferenceCount
vtkWeakPointerBase ** WeakPointers

Detailed Description

Wraps a binary input stream with a VTK interface.

vtkInputStream provides a VTK-style interface wrapping around a standard input stream. The access methods are virtual so that subclasses can transparently provide decoding of an encoded stream. Data lengths for Seek and Read calls refer to the length of the input data. The actual length in the stream may differ for subclasses that implement an encoding scheme.

Definition at line 31 of file vtkInputStream.h.

Member Typedef Documentation

Definition at line 34 of file vtkInputStream.h.

Constructor & Destructor Documentation

vtkInputStream::vtkInputStream ( )
protected
vtkInputStream::~vtkInputStream ( )
protected

Member Function Documentation

virtual const char* vtkInputStream::GetClassName ( )
virtual

Reimplemented from vtkObject.

Reimplemented in vtkBase64InputStream.

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

Reimplemented in vtkBase64InputStream.

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

Reimplemented in vtkBase64InputStream.

static vtkInputStream* vtkInputStream::SafeDownCast ( vtkObject o)
static

Reimplemented from vtkObject.

Reimplemented in vtkBase64InputStream.

static vtkInputStream* vtkInputStream::New ( )
static

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

Reimplemented from vtkObject.

Reimplemented in vtkBase64InputStream.

void vtkInputStream::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.

Reimplemented in vtkBase64InputStream.

virtual void vtkInputStream::SetStream ( istream *  )
virtual

Get/Set the real input stream.

virtual istream* vtkInputStream::GetStream ( )
virtual

Get/Set the real input stream.

virtual void vtkInputStream::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 in vtkBase64InputStream.

virtual int vtkInputStream::Seek ( unsigned long  offset)
virtual

Seek to the given offset in the input data. Returns 1 for success, 0 for failure.

Reimplemented in vtkBase64InputStream.

virtual unsigned long vtkInputStream::Read ( unsigned char *  data,
unsigned long  length 
)
virtual

Read input data of the given length. Returns amount actually read.

Reimplemented in vtkBase64InputStream.

unsigned long vtkInputStream::Read ( char *  data,
unsigned long  length 
)

Read input data of the given length. Returns amount actually read.

virtual void vtkInputStream::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 in vtkBase64InputStream.

Member Data Documentation

istream* vtkInputStream::Stream
protected

Definition at line 72 of file vtkInputStream.h.

unsigned long vtkInputStream::StreamStartPosition
protected

Definition at line 75 of file vtkInputStream.h.


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