vtkInputStream Class Reference

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

#include <vtkInputStream.h>

Inheritance diagram for vtkInputStream:

Collaboration diagram for vtkInputStream:

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

Public Member Functions
virtual int	IsA (const char *type)
vtkInputStream *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent)
virtual void	StartReading ()
virtual int	Seek (vtkTypeInt64 offset)
virtual size_t	Read (void *data, size_t length)
virtual void	EndReading ()
virtual void	SetStream (istream *)
virtual istream *	GetStream ()
Public Member Functions inherited from vtkObject
vtkObject *	NewInstance () const
virtual void	DebugOn ()
virtual void	DebugOff ()
bool	GetDebug ()
void	SetDebug (bool 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)
vtkCommand *	GetCommand (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)
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(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 &)
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 vtkInputStream *	SafeDownCast (vtkObjectBase *o)
static vtkInputStream *	New ()
Static Public Member Functions inherited from vtkObject
static int	IsTypeOf (const char *type)
static vtkObject *	SafeDownCast (vtkObjectBase *o)
static vtkObject *	New ()
static void	BreakOnError ()
static void	SetGlobalWarningDisplay (int val)
static void	GlobalWarningDisplayOn ()
static void	GlobalWarningDisplayOff ()
static int	GetGlobalWarningDisplay ()
Static Public Member Functions inherited from vtkObjectBase
static int	IsTypeOf (const char *name)
static vtkObjectBase *	New ()

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkInputStream ()
	~vtkInputStream ()
size_t	ReadStream (char *data, size_t length)
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 &)
virtual void	ReportReferences (vtkGarbageCollector *)
	vtkObjectBase (const vtkObjectBase &)
void	operator= (const vtkObjectBase &)

Protected Attributes
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

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 32 of file vtkInputStream.h.

Member Typedef Documentation

typedef vtkObject vtkInputStream::Superclass

Definition at line 35 of file vtkInputStream.h.

Constructor & Destructor Documentation

vtkInputStream::vtkInputStream ( )

protected

vtkInputStream::~vtkInputStream ( )

protected

Member Function Documentation

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

static

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 ( vtkObjectBase *  o )

static

virtual vtkObjectBase* vtkInputStream::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkObject.

Reimplemented in vtkBase64InputStream.

vtkInputStream* vtkInputStream::NewInstance

(

)

const

static vtkInputStream* vtkInputStream::New ( )

static

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.

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 ( vtkTypeInt64  offset )

virtual

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

Reimplemented in vtkBase64InputStream.

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

virtual

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

Reimplemented in vtkBase64InputStream.

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.

size_t vtkInputStream::ReadStream ( char *  data, size_t  length  )

protected

Member Data Documentation

istream* vtkInputStream::Stream

protected

Definition at line 70 of file vtkInputStream.h.

vtkTypeInt64 vtkInputStream::StreamStartPosition

protected

Definition at line 74 of file vtkInputStream.h.

---

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

• /home/boeckb/code/depot/group-kitware/vtk/build-release/Utilities/Doxygen/dox/IO/Core/vtkInputStream.h