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 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 ()
Static Public Member Functions
static int	IsTypeOf (const char *type)
static vtkInputStream *	SafeDownCast (vtkObjectBase *o)
static vtkInputStream *	New ()
Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkInputStream ()
	~vtkInputStream ()
size_t	ReadStream (char *data, size_t length)
Protected Attributes
istream *	Stream
vtkTypeInt64	StreamStartPosition

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

Reimplemented from vtkObject.

Reimplemented in vtkBase64InputStream.

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

Reimplemented from vtkObject.

Reimplemented in vtkBase64InputStream.

virtual vtkObjectBase* vtkInputStream::NewInstanceInternal ( ) const [protected, virtual]

Reimplemented from vtkObject.

Reimplemented in vtkBase64InputStream.

vtkInputStream* vtkInputStream::NewInstance ( ) const

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