a helper class used by vtkXMLWriter2 subclasses that write composite datasets. More...

#include <vtkXMLCompositeDataSetWriterHelper.h>

Inheritance diagram for vtkXMLCompositeDataSetWriterHelper:

Collaboration diagram for vtkXMLCompositeDataSetWriterHelper:

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

vtkXMLCompositeDataSetWriterHelper *	NewInstance () const

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

std::string	WriteDataSet (const std::string &path, const std::string &prefix, vtkDataObject *data)
	Write a specific dataset to a file. More...


void	SetWriter (vtkXMLWriterBase *writer)
	Get/Set the writer using this helper. More...

virtual vtkXMLWriterBase *	GetWriter ()
	Get/Set the writer using this helper. 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)

vtkTypeBool	InvokeEvent (unsigned long event)

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

vtkTypeBool	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not. More...

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

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 vtkXMLCompositeDataSetWriterHelper *	New ()

static vtkTypeBool	IsTypeOf (const char *type)

static vtkXMLCompositeDataSetWriterHelper *	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 (vtkTypeBool 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 vtkTypeBool	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

	vtkXMLCompositeDataSetWriterHelper ()

	~vtkXMLCompositeDataSetWriterHelper () override

vtkXMLWriterBase *	GetWriter (int dataType)
	Method to obtain a writer for the given data type. More...

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

a helper class used by vtkXMLWriter2 subclasses that write composite datasets.

vtkXMLCompositeDataSetWriterHelper is a helper class intended to be used by subclasses of vtkXMLWriter2 that want to write composite datasets. It consolidates the logic to write individual datasets for leaf nodes into separate files.

Definition at line 28 of file vtkXMLCompositeDataSetWriterHelper.h.

Member Typedef Documentation

◆ Superclass

typedef vtkObject vtkXMLCompositeDataSetWriterHelper::Superclass

Definition at line 32 of file vtkXMLCompositeDataSetWriterHelper.h.

Constructor & Destructor Documentation

◆ vtkXMLCompositeDataSetWriterHelper()

vtkXMLCompositeDataSetWriterHelper::vtkXMLCompositeDataSetWriterHelper ( )

protected

◆ ~vtkXMLCompositeDataSetWriterHelper()

vtkXMLCompositeDataSetWriterHelper::~vtkXMLCompositeDataSetWriterHelper ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkXMLCompositeDataSetWriterHelper* vtkXMLCompositeDataSetWriterHelper::New ( )

static

◆ IsTypeOf()

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

static

◆ IsA()

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

◆ SafeDownCast()

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

static

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkXMLCompositeDataSetWriterHelper::NewInstanceInternal ( ) const

protectedvirtual

◆ NewInstance()

vtkXMLCompositeDataSetWriterHelper* vtkXMLCompositeDataSetWriterHelper::NewInstance ( ) const

◆ PrintSelf()

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

◆ SetWriter()

void vtkXMLCompositeDataSetWriterHelper::SetWriter ( vtkXMLWriterBase * writer )

Get/Set the writer using this helper.

This is reference counted. So caller should avoid cycles explicitly.

◆ GetWriter() [1/2]

virtual vtkXMLWriterBase* vtkXMLCompositeDataSetWriterHelper::GetWriter ( )

virtual

Get/Set the writer using this helper.

This is reference counted. So caller should avoid cycles explicitly.

◆ WriteDataSet()

std::string vtkXMLCompositeDataSetWriterHelper::WriteDataSet	(	const std::string &	path,
		const std::string &	prefix,
		vtkDataObject *	data
	)

Write a specific dataset to a file.

The dataset cannot be a composite dataset. The implementation uses vtkXMLDataObjectWriter to find a writer to use. Internally, writers are cached and will be reused when same type of data is being written out multiple times.

The filename is created using the path and prefix. The prefix is extended with a .<ext> where the <ext> is dictated by the writer used. vtkXMLWriterBase::GetDefaultFileExtension is used to obtain the extension to use for the file written out.

On success, returns <prefix>.<ext>, otherwise an empty string is returned.

◆ GetWriter() [2/2]

vtkXMLWriterBase* vtkXMLCompositeDataSetWriterHelper::GetWriter ( int dataType )

protected

Method to obtain a writer for the given data type.

Either a new writer is created or one from the cache may be used.

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

IO/ParallelXML/vtkXMLCompositeDataSetWriterHelper.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

◆ vtkXMLCompositeDataSetWriterHelper()

◆ ~vtkXMLCompositeDataSetWriterHelper()

Member Function Documentation

◆ New()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ SetWriter()

◆ GetWriter() [1/2]

◆ WriteDataSet()

◆ GetWriter() [2/2]