vtkResourceStream implementation for memory input This class is a view on existing data, it does not copy or take ownership of it. More...

#include <vtkMemoryResourceStream.h>

Inheritance diagram for vtkMemoryResourceStream:

[legend]

Collaboration diagram for vtkMemoryResourceStream:

[legend]

Public Types
typedef vtkResourceStream	Superclass

Public Types inherited from vtkResourceStream
enum class	SeekDirection { Begin = 0 , Current = 1 , End = 2 }

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

vtkMemoryResourceStream *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses. More...

void	SetBuffer (const void *buffer, std::size_t size)
	Set buffer view to stream. More...


std::size_t	Read (void *buffer, std::size_t bytes) override
	Override vtkResourceStream functions. More...

bool	EndOfStream () override
	Override vtkResourceStream functions. More...

vtkTypeInt64	Seek (vtkTypeInt64 pos, SeekDirection dir) override
	Override vtkResourceStream functions. More...

vtkTypeInt64	Tell () override
	Override vtkResourceStream functions. More...

Public Member Functions inherited from vtkResourceStream
vtkResourceStream *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses. More...

bool	SupportSeek () const
	Check if stream supports Seek and Tell functions. 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)

std::string	GetObjectDescription () const override
	The object description printed in messages and PrintSelf output. More...

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

virtual void	SetObjectName (const std::string &objectName)
	Set/get the name of this object for reporting purposes. More...

virtual std::string	GetObjectName () const
	Set/get the name of this object for reporting purposes. More...

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string. More...

virtual vtkIdType	GetNumberOfGenerationsFromBase (const char *name)
	Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). 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...

bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space. 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...

virtual bool	UsesGarbageCollector () const
	Indicate whether the class uses `vtkGarbageCollector` or not. More...

Static Public Member Functions
static vtkTypeBool	IsTypeOf (const char *type)

static vtkMemoryResourceStream *	SafeDownCast (vtkObjectBase *o)

static vtkMemoryResourceStream *	New ()

Static Public Member Functions inherited from vtkResourceStream
static vtkTypeBool	IsTypeOf (const char *type)

static vtkResourceStream *	SafeDownCast (vtkObjectBase *o)

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 vtkIdType	GetNumberOfGenerationsFromBaseType (const char *name)
	Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). More...

static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. More...

static bool	GetUsingMemkind ()
	A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space. More...

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkMemoryResourceStream ()

	~vtkMemoryResourceStream () override=default

	vtkMemoryResourceStream (const vtkMemoryResourceStream &)=delete

vtkMemoryResourceStream &	operator= (const vtkMemoryResourceStream &)=delete

Protected Member Functions inherited from vtkResourceStream
	vtkResourceStream (bool supportSeek)
	Constructor. More...

	~vtkResourceStream () override

	vtkResourceStream (const vtkResourceStream &)=delete

vtkResourceStream &	operator= (const vtkResourceStream &)=delete

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	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Additional Inherited Members
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

std::string	ObjectName

Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Detailed Description

vtkResourceStream implementation for memory input This class is a view on existing data, it does not copy or take ownership of it.

Definition at line 28 of file vtkMemoryResourceStream.h.

Member Typedef Documentation

◆ Superclass

typedef vtkResourceStream vtkMemoryResourceStream::Superclass

Definition at line 31 of file vtkMemoryResourceStream.h.

Constructor & Destructor Documentation

◆ vtkMemoryResourceStream() [1/2]

vtkMemoryResourceStream::vtkMemoryResourceStream ( )

protected

◆ ~vtkMemoryResourceStream()

vtkMemoryResourceStream::~vtkMemoryResourceStream ( )

overrideprotecteddefault

◆ vtkMemoryResourceStream() [2/2]

vtkMemoryResourceStream::vtkMemoryResourceStream ( const vtkMemoryResourceStream & )

protecteddelete

Member Function Documentation

◆ IsTypeOf()

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

static

◆ IsA()

virtual vtkTypeBool vtkMemoryResourceStream::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 vtkResourceStream.

◆ SafeDownCast()

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

static

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkMemoryResourceStream::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkResourceStream.

◆ NewInstance()

vtkMemoryResourceStream* vtkMemoryResourceStream::NewInstance ( ) const

◆ New()

static vtkMemoryResourceStream* vtkMemoryResourceStream::New ( )

static

◆ PrintSelf()

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

◆ SetBuffer()

void vtkMemoryResourceStream::SetBuffer	(	const void *	buffer,
		std::size_t	size
	)

Set buffer view to stream.

This function does not do any copy, the source buffer must stay valid as as it may be used. Calling this function reset stream position to 0. After this call EndOfStream will return false if size is 0. This function will increase modified time.

Parameters

buffer	the buffer address, may be nullptr if size is 0.
size	the buffer size in bytes, may be 0.

◆ Read()

std::size_t vtkMemoryResourceStream::Read	(	void *	buffer,
		std::size_t	bytes
	)

overridevirtual

Override vtkResourceStream functions.

Implements vtkResourceStream.

◆ EndOfStream()

bool vtkMemoryResourceStream::EndOfStream ( )

overridevirtual

Override vtkResourceStream functions.

Implements vtkResourceStream.

◆ Seek()

vtkTypeInt64 vtkMemoryResourceStream::Seek	(	vtkTypeInt64	pos,
		SeekDirection	dir
	)

overridevirtual

Override vtkResourceStream functions.

Reimplemented from vtkResourceStream.

◆ Tell()

vtkTypeInt64 vtkMemoryResourceStream::Tell ( )

overridevirtual

Override vtkResourceStream functions.

Reimplemented from vtkResourceStream.

◆ operator=()

vtkMemoryResourceStream& vtkMemoryResourceStream::operator= ( const vtkMemoryResourceStream & )

protecteddelete

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

IO/Core/vtkMemoryResourceStream.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkMemoryResourceStream() [1/2]

◆ ~vtkMemoryResourceStream()

◆ vtkMemoryResourceStream() [2/2]

Member Function Documentation

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ New()

◆ PrintSelf()

◆ SetBuffer()

◆ Read()

◆ EndOfStream()

◆ Seek()

◆ Tell()

◆ operator=()