vtkKWEXMLElement Class Reference

#include <vtkKWEXMLElement.h>

Inheritance diagram for vtkKWEXMLElement:

Collaboration diagram for vtkKWEXMLElement:

List of all members.

Public Member Functions
	vtkTypeRevisionMacro (vtkKWEXMLElement, vtkObject)
void	PrintSelf (ostream &os, vtkIndent indent)
const char *	GetAttribute (const char *name)
const char *	GetCharacterData ()
vtkKWEXMLElement *	GetParent ()
unsigned int	GetNumberOfNestedElements ()
vtkKWEXMLElement *	GetNestedElement (unsigned int index)
vtkKWEXMLElement *	FindNestedElement (const char *id)
vtkKWEXMLElement *	FindNestedElementByName (const char *name)
void	RemoveAllNestedElements ()
void	RemoveNestedElement (vtkKWEXMLElement *)
vtkKWEXMLElement *	LookupElement (const char *id)
void	SetAttribute (const char *attrName, const char *attrValue)
void	Merge (vtkKWEXMLElement *element, const char *attributeName)
void	GetElementsByName (const char *name, vtkCollection *elements)
virtual void	SetName (const char *)
virtual char *	GetName ()
virtual char *	GetId ()
unsigned int	GetScalarAttribute (const char *name, int *value)
unsigned int	GetScalarAttribute (const char *name, unsigned int *value)
unsigned int	GetScalarAttribute (const char *name, unsigned long *value)
unsigned int	GetScalarAttribute (const char *name, float *value)
unsigned int	GetScalarAttribute (const char *name, double *value)
unsigned int	GetVectorAttribute (const char *name, unsigned int length, int *value)
unsigned int	GetVectorAttribute (const char *name, unsigned int length, unsigned int *value)
unsigned int	GetVectorAttribute (const char *name, unsigned int length, unsigned long *value)
unsigned int	GetVectorAttribute (const char *name, unsigned int length, float *value)
unsigned int	GetVectorAttribute (const char *name, unsigned int length, double *value)
unsigned int	GetCharacterDataAsVector (unsigned int length, int *value)
unsigned int	GetCharacterDataAsVector (unsigned int length, unsigned long *value)
unsigned int	GetCharacterDataAsVector (unsigned int length, float *value)
unsigned int	GetCharacterDataAsVector (unsigned int length, double *value)
void	AddAttribute (const char *attrName, const char *attrValue)
void	AddAttribute (const char *attrName, unsigned int attrValue)
void	AddAttribute (const char *attrName, double attrValue)
void	AddAttribute (const char *attrName, int attrValue)
void	AddAttribute (const char *attrName, unsigned long attrValue)
void	AddAttribute (const char *attrName, double *vals, unsigned int length)
void	AddAttribute (const char *attrName, int *vals, unsigned int length)
void	AddAttribute (const char *attrName, unsigned long *vals, unsigned int length)
void	AddNestedElement (vtkKWEXMLElement *element, int setPrent)
void	AddNestedElement (vtkKWEXMLElement *element)
void	PrintXML (ostream &os, vtkIndent indent)
void	PrintXML ()
Static Public Member Functions
static vtkKWEXMLElement *	New ()
static vtkStdString	Encode (const char *plaintext)
Protected Member Functions
	vtkKWEXMLElement ()
	~vtkKWEXMLElement ()
virtual void	SetId (const char *)
void	ReadXMLAttributes (const char **atts)
void	AddCharacterData (const char *data, int length)
vtkKWEXMLElement *	LookupElementInScope (const char *id)
vtkKWEXMLElement *	LookupElementUpScope (const char *id)
void	SetParent (vtkKWEXMLElement *parent)
Protected Attributes
vtkKWEXMLElementInternals *	Internal
char *	Name
char *	Id
vtkKWEXMLElement *	Parent
Friends
class	vtkKWEXMLParser

---

Detailed Description

This is used by vtkKWEXMLParser to represent an XML document starting at the root element.

Definition at line 41 of file vtkKWEXMLElement.h.

---

Constructor & Destructor Documentation

vtkKWEXMLElement::vtkKWEXMLElement

(

)

[protected]

vtkKWEXMLElement::~vtkKWEXMLElement

(

)

[protected]

---

Member Function Documentation

vtkKWEXMLElement::vtkTypeRevisionMacro	(	vtkKWEXMLElement	,
		vtkObject
	)

void vtkKWEXMLElement::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)			[virtual]

Reimplemented from vtkObject.

static vtkKWEXMLElement* vtkKWEXMLElement::New

(

)

[static]

Reimplemented from vtkObject.

virtual void vtkKWEXMLElement::SetName

(

const char *

)

[virtual]

Set/Get the name of the element. This is its XML tag. (<Name>).

virtual char* vtkKWEXMLElement::GetName

(

)

[virtual]

Set/Get the name of the element. This is its XML tag. (<Name>).

virtual char* vtkKWEXMLElement::GetId

(

)

[virtual]

Get the id of the element. This is assigned by the XML parser and can be used as an identifier to an element.

const char* vtkKWEXMLElement::GetAttribute

(

const char *

name

)

Get the attribute with the given name. If it doesn't exist, returns 0.

const char* vtkKWEXMLElement::GetCharacterData

(

)

Get the character data for the element.

unsigned int vtkKWEXMLElement::GetScalarAttribute	(	const char *	name,
		int *	value
	)

Get the attribute with the given name converted to a scalar value. Returns whether value was extracted.

unsigned int vtkKWEXMLElement::GetScalarAttribute	(	const char *	name,
		unsigned int *	value
	)

Get the attribute with the given name converted to a scalar value. Returns whether value was extracted.

unsigned int vtkKWEXMLElement::GetScalarAttribute	(	const char *	name,
		unsigned long *	value
	)

Get the attribute with the given name converted to a scalar value. Returns whether value was extracted.

unsigned int vtkKWEXMLElement::GetScalarAttribute	(	const char *	name,
		float *	value
	)

Get the attribute with the given name converted to a scalar value. Returns whether value was extracted.

unsigned int vtkKWEXMLElement::GetScalarAttribute	(	const char *	name,
		double *	value
	)

Get the attribute with the given name converted to a scalar value. Returns whether value was extracted.

unsigned int vtkKWEXMLElement::GetVectorAttribute	(	const char *	name,
		unsigned int	length,
		int *	value
	)

Get the attribute with the given name converted to a scalar value. Returns length of vector read.

unsigned int vtkKWEXMLElement::GetVectorAttribute	(	const char *	name,
		unsigned int	length,
		unsigned int *	value
	)

Get the attribute with the given name converted to a scalar value. Returns length of vector read.

unsigned int vtkKWEXMLElement::GetVectorAttribute	(	const char *	name,
		unsigned int	length,
		unsigned long *	value
	)

Get the attribute with the given name converted to a scalar value. Returns length of vector read.

unsigned int vtkKWEXMLElement::GetVectorAttribute	(	const char *	name,
		unsigned int	length,
		float *	value
	)

Get the attribute with the given name converted to a scalar value. Returns length of vector read.

unsigned int vtkKWEXMLElement::GetVectorAttribute	(	const char *	name,
		unsigned int	length,
		double *	value
	)

Get the attribute with the given name converted to a scalar value. Returns length of vector read.

unsigned int vtkKWEXMLElement::GetCharacterDataAsVector	(	unsigned int	length,
		int *	value
	)

Get the character data converted to a scalar value. Returns length of vector read.

unsigned int vtkKWEXMLElement::GetCharacterDataAsVector	(	unsigned int	length,
		unsigned long *	value
	)

Get the character data converted to a scalar value. Returns length of vector read.

unsigned int vtkKWEXMLElement::GetCharacterDataAsVector	(	unsigned int	length,
		float *	value
	)

Get the character data converted to a scalar value. Returns length of vector read.

unsigned int vtkKWEXMLElement::GetCharacterDataAsVector	(	unsigned int	length,
		double *	value
	)

Get the character data converted to a scalar value. Returns length of vector read.

vtkKWEXMLElement* vtkKWEXMLElement::GetParent

(

)

Get the parent of this element.

unsigned int vtkKWEXMLElement::GetNumberOfNestedElements

(

)

Get the number of elements nested in this one.

vtkKWEXMLElement* vtkKWEXMLElement::GetNestedElement

(

unsigned int

index

)

Get the element nested in this one at the given index.

vtkKWEXMLElement* vtkKWEXMLElement::FindNestedElement

(

const char *

id

)

Find a nested element with the given id. Note that this searches only the immediate children of this vtkKWEXMLElement.

vtkKWEXMLElement* vtkKWEXMLElement::FindNestedElementByName

(

const char *

name

)

Locate a nested element with the given tag name.

void vtkKWEXMLElement::RemoveAllNestedElements

(

)

Removes all nested elements.

void vtkKWEXMLElement::RemoveNestedElement

(

vtkKWEXMLElement *

)

Remove a particular element.

vtkKWEXMLElement* vtkKWEXMLElement::LookupElement

(

const char *

id

)

Lookup the element with the given id, starting at this scope.

void vtkKWEXMLElement::AddAttribute	(	const char *	attrName,
		const char *	attrValue
	)

Given it's name and value, add an attribute.

void vtkKWEXMLElement::AddAttribute	(	const char *	attrName,
		unsigned int	attrValue
	)

Given it's name and value, add an attribute.

void vtkKWEXMLElement::AddAttribute	(	const char *	attrName,
		double	attrValue
	)

Given it's name and value, add an attribute.

void vtkKWEXMLElement::AddAttribute	(	const char *	attrName,
		int	attrValue
	)

Given it's name and value, add an attribute.

void vtkKWEXMLElement::AddAttribute	(	const char *	attrName,
		unsigned long	attrValue
	)

Given it's name and value, add an attribute.

void vtkKWEXMLElement::AddAttribute	(	const char *	attrName,
		double *	vals,
		unsigned int	length
	)

Given it's name and value, add an attribute.

void vtkKWEXMLElement::AddAttribute	(	const char *	attrName,
		int *	vals,
		unsigned int	length
	)

Given it's name and value, add an attribute.

void vtkKWEXMLElement::AddAttribute	(	const char *	attrName,
		unsigned long *	vals,
		unsigned int	length
	)

Given it's name and value, add an attribute.

void vtkKWEXMLElement::SetAttribute	(	const char *	attrName,
		const char *	attrValue
	)

Given it's name and value, set an attribute. If an attribute with the given name already exists, it replaces the old attribute. chars that need to be XML escaped will be done so internally for example " will be converted to "

void vtkKWEXMLElement::AddNestedElement	(	vtkKWEXMLElement *	element,
		int	setPrent
	)

Add a sub-element. The parent element keeps a reference to sub-element. If setParent is true, the nested element's parent is set as this.

void vtkKWEXMLElement::AddNestedElement

(

vtkKWEXMLElement *

element

)

Add a sub-element. The parent element keeps a reference to sub-element. If setParent is true, the nested element's parent is set as this.

void vtkKWEXMLElement::PrintXML	(	ostream &	os,
		vtkIndent	indent
	)

Serialize (as XML) in the given stream.

void vtkKWEXMLElement::PrintXML

(

)

Serialize (as XML) in the given stream.

void vtkKWEXMLElement::Merge	(	vtkKWEXMLElement *	element,
		const char *	attributeName
	)

Merges another element with this one, both having the same name. If any attribute, character data or nested element exists in both, the passed in one will override this one's. If they don't exist, they'll be added. If nested elements have the same names, the optional attributeName maybe passed in as another criteria to determine what to merge in case of same names.

void vtkKWEXMLElement::GetElementsByName	(	const char *	name,
		vtkCollection *	elements
	)

Similar to DOM sepecific getElementsByTagName(). Returns a list of vtkKWEXMLElements with the given name in the order in which they will be encountered in a preorder traversal of the sub-tree under this node. The elements are populated in the vtkCollection passed as an argument.

static vtkStdString vtkKWEXMLElement::Encode

(

const char *

plaintext

)

[static]

Encode a string.

virtual void vtkKWEXMLElement::SetId

(

const char *

)

[protected, virtual]

void vtkKWEXMLElement::ReadXMLAttributes

(

const char **

atts

)

[protected]

void vtkKWEXMLElement::AddCharacterData	(	const char *	data,
		int	length
	)			[protected]

vtkKWEXMLElement* vtkKWEXMLElement::LookupElementInScope

(

const char *

id

)

[protected]

vtkKWEXMLElement* vtkKWEXMLElement::LookupElementUpScope

(

const char *

id

)

[protected]

void vtkKWEXMLElement::SetParent

(

vtkKWEXMLElement *

parent

)

[protected]

---

Friends And Related Function Documentation

friend class vtkKWEXMLParser [friend]

Definition at line 208 of file vtkKWEXMLElement.h.

---

Member Data Documentation

vtkKWEXMLElementInternals* vtkKWEXMLElement::Internal [protected]

Definition at line 188 of file vtkKWEXMLElement.h.

char* vtkKWEXMLElement::Name [protected]

Definition at line 190 of file vtkKWEXMLElement.h.

char* vtkKWEXMLElement::Id [protected]

Definition at line 191 of file vtkKWEXMLElement.h.

vtkKWEXMLElement* vtkKWEXMLElement::Parent [protected]

Definition at line 194 of file vtkKWEXMLElement.h.

---

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

• dox/IO/vtkKWEXMLElement.h