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 Member Functions
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class. More...
vtkInputStream *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses. More...
virtual void	StartReading ()
	Called after the stream position has been set by the caller, but before any Seek or Read calls. More...
virtual int	Seek (vtkTypeInt64 offset)
	Seek to the given offset in the input data. More...
virtual size_t	Read (void *data, size_t length)
	Read input data of the given length. More...
virtual void	EndReading ()
	Called after all desired calls to Seek and Read have been made. 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 ()
vtkTypeBool	HasObserver (unsigned long event)
vtkTypeBool	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...
vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
vtkTypeBool	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 vtkTypeBool	IsTypeOf (const char *type)
static vtkInputStream *	SafeDownCast (vtkObjectBase *o)
static vtkInputStream *	New ()
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
	vtkInputStream ()
	~vtkInputStream () override
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=nullptr)
	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
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 33 of file vtkInputStream.h.

Member Typedef Documentation

typedef vtkObject vtkInputStream::Superclass

Definition at line 36 of file vtkInputStream.h.

Constructor & Destructor Documentation

vtkInputStream::vtkInputStream ( )

protected

vtkInputStream::~vtkInputStream ( )

overrideprotected

Member Function Documentation

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

static

virtual vtkTypeBool 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 vtkObjectBase.

Reimplemented in vtkBase64InputStream.

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

static

virtual vtkObjectBase* vtkInputStream::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented in vtkBase64InputStream.

vtkInputStream* vtkInputStream::NewInstance

(

)

const

static vtkInputStream* vtkInputStream::New ( )

static

void vtkInputStream::PrintSelf ( ostream &  os, vtkIndent  indent  )

overridevirtual

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

vtkTypeInt64 vtkInputStream::StreamStartPosition

protected

Definition at line 84 of file vtkInputStream.h.

---

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

• /home/demarle/Source/VTK/release/8.2/build/Utilities/Doxygen/dox/IO/Core/vtkInputStream.h