XML utilities. More...

#include <vtkXMLUtilities.h>

Inheritance diagram for vtkXMLUtilities:

Collaboration diagram for vtkXMLUtilities:

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

vtkXMLUtilities *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses. 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 vtkXMLUtilities *	New ()

static vtkTypeBool	IsTypeOf (const char *type)

static vtkXMLUtilities *	SafeDownCast (vtkObjectBase *o)

static void	EncodeString (const char *input, int input_encoding, ostream &output, int output_encoding, int special_entities=0)
	Encode a string from one format to another (see VTK_ENCODING_... More...

static void	CollateAttributes (vtkXMLDataElement , ostream &, const char sep=nullptr)
	Collate a vtkXMLDataElement's attributes to a stream as a series of name="value" pairs (the separator between each pair can be specified, if not, it defaults to a space). More...

static void	FlattenElement (vtkXMLDataElement , ostream &, vtkIndent indent=nullptr, int indent_attributes=1)
	Flatten a vtkXMLDataElement to a stream, i.e. More...

static int	WriteElementToFile (vtkXMLDataElement , VTK_FILEPATH const char filename, vtkIndent *indent=nullptr)
	Write a vtkXMLDataElement to a file (in a flattened textual form) Note that the resulting character-encoding will be UTF-8. More...

static void	ReadElementFromAttributeArray (vtkXMLDataElement element, const char *atts, int encoding)
	Sets attributes of an element from an array of encoded attributes. More...

static int	FindSimilarElements (vtkXMLDataElement elem, vtkXMLDataElement tree, vtkXMLDataElement ***results)
	Find all elements in 'tree' that are similar to 'elem' (using the vtkXMLDataElement::IsEqualTo() predicate). More...


static vtkXMLDataElement *	ReadElementFromStream (istream &, int encoding=VTK_ENCODING_NONE)
	Read a vtkXMLDataElement from a stream, string or file. More...

static vtkXMLDataElement *	ReadElementFromString (const char *str, int encoding=VTK_ENCODING_NONE)
	Read a vtkXMLDataElement from a stream, string or file. More...

static vtkXMLDataElement *	ReadElementFromFile (VTK_FILEPATH const char *filename, int encoding=VTK_ENCODING_NONE)
	Read a vtkXMLDataElement from a stream, string or file. More...


static void	FactorElements (vtkXMLDataElement *tree)
	Factor and unfactor a tree. More...

static void	UnFactorElements (vtkXMLDataElement *tree)
	Factor and unfactor a tree. More...

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

	vtkXMLUtilities ()=default

	~vtkXMLUtilities () override=default

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 &)

Static Protected Member Functions
static int	FactorElementsInternal (vtkXMLDataElement tree, vtkXMLDataElement root, vtkXMLDataElement *pool)

static int	UnFactorElementsInternal (vtkXMLDataElement tree, vtkXMLDataElement pool)

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

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

Additional Inherited Members
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

XML utilities.

vtkXMLUtilities provides XML-related convenience functions.

See also: vtkXMLDataElement

Definition at line 21 of file vtkXMLUtilities.h.

Member Typedef Documentation

◆ Superclass

typedef vtkObject vtkXMLUtilities::Superclass

Definition at line 25 of file vtkXMLUtilities.h.

Constructor & Destructor Documentation

◆ vtkXMLUtilities()

vtkXMLUtilities::vtkXMLUtilities ( )

protecteddefault

◆ ~vtkXMLUtilities()

vtkXMLUtilities::~vtkXMLUtilities ( )

overrideprotecteddefault

Member Function Documentation

◆ New()

static vtkXMLUtilities* vtkXMLUtilities::New ( )

static

◆ IsTypeOf()

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

static

◆ IsA()

virtual vtkTypeBool vtkXMLUtilities::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 vtkXMLUtilities* vtkXMLUtilities::SafeDownCast ( vtkObjectBase * o )

static

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkXMLUtilities::NewInstanceInternal ( ) const

protectedvirtual

◆ NewInstance()

vtkXMLUtilities* vtkXMLUtilities::NewInstance ( ) const

◆ PrintSelf()

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

◆ EncodeString()

static void vtkXMLUtilities::EncodeString	(	const char *	input,
		int	input_encoding,
		ostream &	output,
		int	output_encoding,
		int	special_entities = `0`
	)

static

Encode a string from one format to another (see VTK_ENCODING_...

constants). If special_entites is true, convert some characters to their corresponding character entities.

◆ CollateAttributes()

static void vtkXMLUtilities::CollateAttributes	(	vtkXMLDataElement *	,
		ostream &	,
		const char *	sep = `nullptr`
	)

static

Collate a vtkXMLDataElement's attributes to a stream as a series of name="value" pairs (the separator between each pair can be specified, if not, it defaults to a space).

Note that the resulting character-encoding will be UTF-8 (we assume that this function is used to create XML files/streams).

◆ FlattenElement()

static void vtkXMLUtilities::FlattenElement	(	vtkXMLDataElement *	,
		ostream &	,
		vtkIndent *	indent = `nullptr`,
		int	indent_attributes = `1`
	)

static

Flatten a vtkXMLDataElement to a stream, i.e.

output a textual stream corresponding to that XML element, its attributes and its nested elements. If 'indent' is not nullptr, it is used to indent the whole tree. If 'indent' is not nullptr and 'indent_attributes' is true, attributes will be indented as well. Note that the resulting character-encoding will be UTF-8 (we assume that this function is used to create XML files/streams).

◆ WriteElementToFile()

static int vtkXMLUtilities::WriteElementToFile	(	vtkXMLDataElement *	,
		VTK_FILEPATH const char *	filename,
		vtkIndent *	indent = `nullptr`
	)

static

Write a vtkXMLDataElement to a file (in a flattened textual form) Note that the resulting character-encoding will be UTF-8.

Return 1 on success, 0 otherwise.

◆ ReadElementFromStream()

static vtkXMLDataElement* vtkXMLUtilities::ReadElementFromStream	(	istream &	,
		int	encoding = `VTK_ENCODING_NONE`
	)

static

Read a vtkXMLDataElement from a stream, string or file.

The 'encoding' parameter will be used to set the internal encoding of the attributes of the data elements created by those functions (conversion from the XML stream encoding to that new encoding will be performed automatically). If set to VTK_ENCODING_NONE, the encoding won't be changed and will default to the default vtkXMLDataElement encoding. Return the root element on success, nullptr otherwise. Note that you have to call Delete() on the element returned by that function to ensure it is freed properly.

◆ ReadElementFromString()

static vtkXMLDataElement* vtkXMLUtilities::ReadElementFromString	(	const char *	str,
		int	encoding = `VTK_ENCODING_NONE`
	)

static

Read a vtkXMLDataElement from a stream, string or file.

The 'encoding' parameter will be used to set the internal encoding of the attributes of the data elements created by those functions (conversion from the XML stream encoding to that new encoding will be performed automatically). If set to VTK_ENCODING_NONE, the encoding won't be changed and will default to the default vtkXMLDataElement encoding. Return the root element on success, nullptr otherwise. Note that you have to call Delete() on the element returned by that function to ensure it is freed properly.

◆ ReadElementFromFile()

static vtkXMLDataElement* vtkXMLUtilities::ReadElementFromFile	(	VTK_FILEPATH const char *	filename,
		int	encoding = `VTK_ENCODING_NONE`
	)

static

Read a vtkXMLDataElement from a stream, string or file.

The 'encoding' parameter will be used to set the internal encoding of the attributes of the data elements created by those functions (conversion from the XML stream encoding to that new encoding will be performed automatically). If set to VTK_ENCODING_NONE, the encoding won't be changed and will default to the default vtkXMLDataElement encoding. Return the root element on success, nullptr otherwise. Note that you have to call Delete() on the element returned by that function to ensure it is freed properly.

◆ ReadElementFromAttributeArray()

static void vtkXMLUtilities::ReadElementFromAttributeArray	(	vtkXMLDataElement *	element,
		const char **	atts,
		int	encoding
	)

static

Sets attributes of an element from an array of encoded attributes.

The 'encoding' parameter will be used to set the internal encoding of the attributes of the data elements created by those functions (conversion from the XML stream encoding to that new encoding will be performed automatically). If set to VTK_ENCODING_NONE, the encoding won't be changed and will default to the default vtkXMLDataElement encoding.

◆ FindSimilarElements()

static int vtkXMLUtilities::FindSimilarElements	(	vtkXMLDataElement *	elem,
		vtkXMLDataElement *	tree,
		vtkXMLDataElement ***	results
	)

static

Find all elements in 'tree' that are similar to 'elem' (using the vtkXMLDataElement::IsEqualTo() predicate).

Return the number of elements found and store those elements in 'results' (automatically allocated). Warning: the results do not include 'elem' if it was found in the tree ; do not forget to deallocate 'results' if something was found.

◆ FactorElements()

static void vtkXMLUtilities::FactorElements ( vtkXMLDataElement * tree )

static

Factor and unfactor a tree.

This operation looks for duplicate elements in the tree, and replace them with references to a pool of elements. Unfactoring a non-factored element is harmless.

◆ UnFactorElements()

static void vtkXMLUtilities::UnFactorElements ( vtkXMLDataElement * tree )

static

Factor and unfactor a tree.

This operation looks for duplicate elements in the tree, and replace them with references to a pool of elements. Unfactoring a non-factored element is harmless.

◆ FactorElementsInternal()

static int vtkXMLUtilities::FactorElementsInternal	(	vtkXMLDataElement *	tree,
		vtkXMLDataElement *	root,
		vtkXMLDataElement *	pool
	)

staticprotected

◆ UnFactorElementsInternal()

static int vtkXMLUtilities::UnFactorElementsInternal	(	vtkXMLDataElement *	tree,
		vtkXMLDataElement *	pool
	)

staticprotected

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

IO/XMLParser/vtkXMLUtilities.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkXMLUtilities()

◆ ~vtkXMLUtilities()

Member Function Documentation

◆ New()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ EncodeString()

◆ CollateAttributes()

◆ FlattenElement()

◆ WriteElementToFile()

◆ ReadElementFromStream()

◆ ReadElementFromString()

◆ ReadElementFromFile()

◆ ReadElementFromAttributeArray()

◆ FindSimilarElements()

◆ FactorElements()

◆ UnFactorElements()

◆ FactorElementsInternal()

◆ UnFactorElementsInternal()