XML utilities. More...

#include <vtkXMLUtilities.h>

Inheritance diagram for vtkXMLUtilities:

Collaboration diagram for vtkXMLUtilities:

Public Types
typedef vtkObject	Superclass

Public Types inherited from vtkObject
typedef vtkObjectBase	Superclass

Public Member Functions
virtual int	IsA (const char *type)

vtkXMLUtilities *	NewInstance () const

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

virtual void	DebugOn ()

virtual void	DebugOff ()

bool	GetDebug ()

void	SetDebug (bool debugFlag)

virtual void	Modified ()

virtual unsigned long	GetMTime ()

virtual void	PrintSelf (ostream &os, vtkIndent indent)

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)

vtkCommand *	GetCommand (unsigned long tag)

void	RemoveObserver (vtkCommand *)

void	RemoveObservers (unsigned long event, vtkCommand *)

void	RemoveObservers (const char event, vtkCommand )

int	HasObserver (unsigned long event, vtkCommand *)

int	HasObserver (const char event, vtkCommand )

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

int	HasObserver (unsigned long event)

int	HasObserver (const char *event)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

int	InvokeEvent (unsigned long event, void *callData)

int	InvokeEvent (const char event, void callData)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const

virtual void	Delete ()

virtual void	FastDelete ()

void	Print (ostream &os)

virtual void	Register (vtkObjectBase *o)

virtual void	UnRegister (vtkObjectBase *o)

void	SetReferenceCount (int)

void	PrintRevisions (ostream &)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

Static Public Member Functions
static vtkXMLUtilities *	New ()

static int	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)


static void	CollateAttributes (vtkXMLDataElement , ostream &, const char sep=0)


static void	FlattenElement (vtkXMLDataElement , ostream &, vtkIndent indent=0, int indent_attributes=1)


static int	WriteElementToFile (vtkXMLDataElement , const char filename, vtkIndent *indent=0)


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

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

static vtkXMLDataElement *	ReadElementFromFile (const char *filename, int encoding=VTK_ENCODING_NONE)


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


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


static void	FactorElements (vtkXMLDataElement *tree)

static void	UnFactorElements (vtkXMLDataElement *tree)

Static Public Member Functions inherited from vtkObject
static int	IsTypeOf (const char *type)

static vtkObject *	SafeDownCast (vtkObjectBase *o)

static vtkObject *	New ()

static void	BreakOnError ()

static void	SetGlobalWarningDisplay (int val)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

Static Public Member Functions inherited from vtkObjectBase
static int	IsTypeOf (const char *name)

static vtkObjectBase *	New ()

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkXMLUtilities ()

	~vtkXMLUtilities ()

Protected Member Functions inherited from vtkObject
	vtkObject ()

virtual	~vtkObject ()

virtual void	RegisterInternal (vtkObjectBase *, int check)

virtual void	UnRegisterInternal (vtkObjectBase *, int check)

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)

void	InternalReleaseFocus ()

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	CollectRevisions (ostream &)

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)

Additional Inherited Members
Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Detailed Description

XML utilities.

vtkXMLUtilities provides XML-related convenience functions.

See also: vtkXMLDataElement

Definition at line 31 of file vtkXMLUtilities.h.

Member Typedef Documentation

typedef vtkObject vtkXMLUtilities::Superclass

Definition at line 35 of file vtkXMLUtilities.h.

Constructor & Destructor Documentation

vtkXMLUtilities::vtkXMLUtilities ( )

inlineprotected

Definition at line 139 of file vtkXMLUtilities.h.

vtkXMLUtilities::~vtkXMLUtilities ( )

inlineprotected

Definition at line 140 of file vtkXMLUtilities.h.

Member Function Documentation

static vtkXMLUtilities* vtkXMLUtilities::New ( )

static

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

static

virtual int 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 vtkObject.

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

static

virtual vtkObjectBase* vtkXMLUtilities::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkObject.

vtkXMLUtilities* vtkXMLUtilities::NewInstance ( ) const

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.

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

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

static void vtkXMLUtilities::FlattenElement	(	vtkXMLDataElement *	,
		ostream &	,
		vtkIndent *	indent = `0`,
		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 NULL, it is used to indent the whole tree. If 'indent' is not NULL 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).

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

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.

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, NULL otherwise. Note that you have to call Delete() on the element returned by that function to ensure it is freed properly.

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, NULL otherwise. Note that you have to call Delete() on the element returned by that function to ensure it is freed properly.

static vtkXMLDataElement* vtkXMLUtilities::ReadElementFromFile	(	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, NULL otherwise. Note that you have to call Delete() on the element returned by that function to ensure it is freed properly.

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.

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.

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.

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.

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

staticprotected

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

staticprotected

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

/home/boeckb/code/depot/group-kitware/vtk/build-release/Utilities/Doxygen/dox/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

Constructor & Destructor Documentation

Member Function Documentation