Represents an XML element and those nested inside. More...

#include <vtkXMLDataElement.h>

Inheritance diagram for vtkXMLDataElement:

Collaboration diagram for vtkXMLDataElement:

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.

vtkXMLDataElement *	NewInstance () const

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

const char *	GetAttribute (const char *name)
	Get the attribute with the given name.

void	SetAttribute (const char name, const char value)
	Set the attribute with the given name and value.

int	GetScalarAttribute (const char *name, long long &value)

int	GetVectorAttribute (const char name, int length, long long value)

void	SetVectorAttribute (const char name, int length, long long const value)

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

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

void	SetVectorAttribute (const char name, int length, unsigned long long const value)

int	GetWordTypeAttribute (const char *name, int &value)
	Get the attribute with the given name and converted to a word type.

const char *	GetAttributeName (int idx)
	Get the n-th attribute name.

const char *	GetAttributeValue (int idx)
	Get the n-th attribute value.

virtual vtkXMLDataElement *	GetRoot ()
	Get root of the XML tree this element is part of.

int	GetNumberOfNestedElements ()
	Get the number of elements nested in this one.

vtkXMLDataElement *	GetNestedElement (int index)
	Get the element nested in this one at the given index.

void	AddNestedElement (vtkXMLDataElement *element)
	Add nested element.

virtual void	RemoveNestedElement (vtkXMLDataElement *)
	Remove nested element.

virtual void	RemoveAllNestedElements ()
	Remove all nested elements.

vtkXMLDataElement *	LookupElementWithName (const char *name)
	Find the first nested element with given name.

vtkXMLDataElement *	LookupElement (const char *id)
	Lookup the element with the given id, starting at this scope.

virtual int	IsEqualTo (vtkXMLDataElement *elem)
	Check if the instance has the same name, attributes, character data and nested elements contents than the given element (this method is applied recursively on the nested elements, and they must be stored in the same order).

virtual void	DeepCopy (vtkXMLDataElement *elem)
	Copy this element from another of the same type (elem), recursively.


virtual char *	GetName ()
	Set/Get the name of the element.

virtual void	SetName (const char *_arg)
	Set/Get the name of the element.


virtual char *	GetId ()
	Set/Get the value of the id attribute of the element, if any.

virtual void	SetId (const char *)
	Set/Get the value of the id attribute of the element, if any.


void	SetCharacterData (const char *data, int length)
	Set/Get the character data between XML start/end tags.

void	AddCharacterData (const char *c, size_t length)
	Set/Get the character data between XML start/end tags.

virtual char *	GetCharacterData ()
	Set/Get the character data between XML start/end tags.


int	GetScalarAttribute (const char *name, int &value)
	Get the attribute with the given name and converted to a scalar value.

int	GetScalarAttribute (const char *name, float &value)
	Get the attribute with the given name and converted to a scalar value.

int	GetScalarAttribute (const char *name, double &value)
	Get the attribute with the given name and converted to a scalar value.

int	GetScalarAttribute (const char *name, long &value)
	Get the attribute with the given name and converted to a scalar value.

int	GetScalarAttribute (const char *name, unsigned long &value)
	Get the attribute with the given name and converted to a scalar value.


void	SetIntAttribute (const char *name, int value)
	Set the attribute with the given name.

void	SetFloatAttribute (const char *name, float value)
	Set the attribute with the given name.

void	SetDoubleAttribute (const char *name, double value)
	Set the attribute with the given name.

void	SetUnsignedLongAttribute (const char *name, unsigned long value)
	Set the attribute with the given name.


int	GetVectorAttribute (const char name, int length, int value)
	Get the attribute with the given name and converted to a scalar value.

int	GetVectorAttribute (const char name, int length, float value)
	Get the attribute with the given name and converted to a scalar value.

int	GetVectorAttribute (const char name, int length, double value)
	Get the attribute with the given name and converted to a scalar value.

int	GetVectorAttribute (const char name, int length, long value)
	Get the attribute with the given name and converted to a scalar value.

int	GetVectorAttribute (const char name, int length, unsigned long value)
	Get the attribute with the given name and converted to a scalar value.


void	SetVectorAttribute (const char name, int length, const int value)
	Set the attribute with the given name.

void	SetVectorAttribute (const char name, int length, const float value)
	Set the attribute with the given name.

void	SetVectorAttribute (const char name, int length, const double value)
	Set the attribute with the given name.

void	SetVectorAttribute (const char name, int length, const unsigned long value)
	Set the attribute with the given name.


virtual int	GetNumberOfAttributes ()
	Get the number of attributes.


virtual void	RemoveAttribute (const char *name)
	Remove one or all attributes.

virtual void	RemoveAllAttributes ()
	Remove one or all attributes.


vtkXMLDataElement *	GetParent ()
	Set/Get the parent of this element.

void	SetParent (vtkXMLDataElement *parent)
	Set/Get the parent of this element.


vtkXMLDataElement *	FindNestedElement (const char *id)
	Find the first nested element with the given id, given name, or given name and id.

vtkXMLDataElement *	FindNestedElementWithName (const char *name)
	Find the first nested element with the given id, given name, or given name and id.

vtkXMLDataElement *	FindNestedElementWithNameAndId (const char name, const char id)
	Find the first nested element with the given id, given name, or given name and id.

vtkXMLDataElement *	FindNestedElementWithNameAndAttribute (const char name, const char att_name, const char *att_value)
	Find the first nested element with the given id, given name, or given name and id.


virtual vtkTypeInt64	GetXMLByteIndex ()
	Set/Get the offset from the beginning of the XML document to this element.

virtual void	SetXMLByteIndex (vtkTypeInt64)
	Set/Get the offset from the beginning of the XML document to this element.


virtual void	SetAttributeEncoding (int)
	Get/Set the internal character encoding of the attributes.

virtual int	GetAttributeEncoding ()
	Get/Set the internal character encoding of the attributes.


void	PrintXML (ostream &os, vtkIndent indent)
	Prints element tree as XML.

void	PrintXML (VTK_FILEPATH const char *fname)
	Prints element tree as XML.


virtual int	GetCharacterDataWidth ()
	Get/Set the width (in number of fields) that character data (that between open and closing tags ie.

virtual void	SetCharacterDataWidth (int)
	Get/Set the width (in number of fields) that character data (that between open and closing tags ie.

Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)

virtual void	DebugOn ()
	Turn debugging output on.

virtual void	DebugOff ()
	Turn debugging output off.

bool	GetDebug ()
	Get the value of the debug flag.

void	SetDebug (bool debugFlag)
	Set the value of the debug flag.

virtual void	Modified ()
	Update the modification time for this object.

virtual vtkMTimeType	GetMTime ()
	Return this object's modified time.

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

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)

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObservers (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkTypeBool	HasObserver (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

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.

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.

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.

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

int	InvokeEvent (const char event, void callData)
	This method invokes an event and return whether the event was aborted or not.

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

virtual vtkTypeBool	IsA (const char *name)
	Return 1 if this class is the same type of (or a subclass of) the named class.

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

virtual void	Delete ()
	Delete a VTK object.

virtual void	FastDelete ()
	Delete a reference to this object.

void	InitializeObjectBase ()

void	Print (ostream &os)
	Print an object to an ostream.

virtual void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object).

virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object).

int	GetReferenceCount ()
	Return the current reference count of this object.

void	SetReferenceCount (int)
	Sets the reference count.

bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space.

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

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

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

static vtkXMLDataElement *	SafeDownCast (vtkObjectBase *o)

static vtkXMLDataElement *	New ()

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.

static void	BreakOnError ()
	This method is called when vtkErrorMacro executes.

static void	SetGlobalWarningDisplay (int val)
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static int	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

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.

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

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

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

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.

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkXMLDataElement ()

	~vtkXMLDataElement () override

virtual vtkTypeInt64	GetInlineDataPosition ()

virtual void	SetInlineDataPosition (vtkTypeInt64)

vtkXMLDataElement *	LookupElementInScope (const char *id)

vtkXMLDataElement *	LookupElementUpScope (const char *id)

void	PrintCharacterData (ostream &os, vtkIndent indent)

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.

void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events.

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	RegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Static Protected Member Functions
static int	IsSpace (char c)

static void	PrintWithEscapedData (ostream &os, const char *data)

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

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

Protected Attributes
char *	Name

char *	Id

int	CharacterDataWidth

char *	CharacterData

size_t	CharacterDataBlockSize

size_t	CharacterDataBufferSize

size_t	EndOfCharacterData

int	IgnoreCharacterData

vtkTypeInt64	InlineDataPosition

vtkTypeInt64	XMLByteIndex

char **	AttributeNames

char **	AttributeValues

int	NumberOfAttributes

int	AttributesSize

int	AttributeEncoding

int	NumberOfNestedElements

int	NestedElementsSize

vtkXMLDataElement **	NestedElements

vtkXMLDataElement *	Parent

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

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

vtkWeakPointerBase **	WeakPointers

Friends
class	vtkXMLDataParser

class	vtkXMLMaterialParser

Detailed Description

Represents an XML element and those nested inside.

vtkXMLDataElement is used by vtkXMLDataParser to represent an XML element. It provides methods to access the element's attributes and nested elements in a convenient manner. This allows easy traversal of an input XML file by vtkXMLReader and its subclasses.

See also: vtkXMLDataParser

Definition at line 36 of file vtkXMLDataElement.h.

Member Typedef Documentation

◆ Superclass

typedef vtkObject vtkXMLDataElement::Superclass

Definition at line 39 of file vtkXMLDataElement.h.

Constructor & Destructor Documentation

◆ vtkXMLDataElement()

vtkXMLDataElement::vtkXMLDataElement ( )

protected

◆ ~vtkXMLDataElement()

vtkXMLDataElement::~vtkXMLDataElement ( )

overrideprotected

Member Function Documentation

◆ IsTypeOf()

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

static

◆ IsA()

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

static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkXMLDataElement::NewInstanceInternal ( ) const

protectedvirtual

◆ NewInstance()

vtkXMLDataElement * vtkXMLDataElement::NewInstance ( ) const

◆ PrintSelf()

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

◆ New()

static vtkXMLDataElement * vtkXMLDataElement::New ( )

static

◆ GetName()

virtual char * vtkXMLDataElement::GetName ( )

virtual

Set/Get the name of the element.

This is its XML tag.

◆ SetName()

virtual void vtkXMLDataElement::SetName ( const char * _arg )

virtual

Set/Get the name of the element.

This is its XML tag.

◆ GetId()

virtual char * vtkXMLDataElement::GetId ( )

virtual

Set/Get the value of the id attribute of the element, if any.

◆ SetId()

virtual void vtkXMLDataElement::SetId ( const char * )

virtual

Set/Get the value of the id attribute of the element, if any.

◆ GetAttribute()

const char * vtkXMLDataElement::GetAttribute ( const char * name )

Get the attribute with the given name.

If it doesn't exist, returns 0.

◆ SetAttribute()

void vtkXMLDataElement::SetAttribute	(	const char *	name,
		const char *	value
	)

Set the attribute with the given name and value.

If it doesn't exist, adds it.

◆ SetCharacterData()

void vtkXMLDataElement::SetCharacterData	(	const char *	data,
		int	length
	)

Set/Get the character data between XML start/end tags.

◆ AddCharacterData()

void vtkXMLDataElement::AddCharacterData	(	const char *	c,
		size_t	length
	)

inline

Set/Get the character data between XML start/end tags.

Definition at line 350 of file vtkXMLDataElement.h.

◆ GetCharacterData()

virtual char * vtkXMLDataElement::GetCharacterData ( )

virtual

Set/Get the character data between XML start/end tags.

◆ GetScalarAttribute() [1/7]

int vtkXMLDataElement::GetScalarAttribute	(	const char *	name,
		int &	value
	)

Get the attribute with the given name and converted to a scalar value.

Returns whether value was extracted.

◆ GetScalarAttribute() [2/7]

int vtkXMLDataElement::GetScalarAttribute	(	const char *	name,
		float &	value
	)

Get the attribute with the given name and converted to a scalar value.

Returns whether value was extracted.

◆ GetScalarAttribute() [3/7]

int vtkXMLDataElement::GetScalarAttribute	(	const char *	name,
		double &	value
	)

Get the attribute with the given name and converted to a scalar value.

Returns whether value was extracted.

◆ GetScalarAttribute() [4/7]

int vtkXMLDataElement::GetScalarAttribute	(	const char *	name,
		long &	value
	)

Get the attribute with the given name and converted to a scalar value.

Returns whether value was extracted.

◆ GetScalarAttribute() [5/7]

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

Get the attribute with the given name and converted to a scalar value.

Returns whether value was extracted.

◆ SetIntAttribute()

void vtkXMLDataElement::SetIntAttribute	(	const char *	name,
		int	value
	)

Set the attribute with the given name.

We can not use the same GetScalarAttribute() construct since the compiler will not be able to resolve between SetAttribute(..., int) and SetAttribute(..., unsigned long).

◆ SetFloatAttribute()

void vtkXMLDataElement::SetFloatAttribute	(	const char *	name,
		float	value
	)

Set the attribute with the given name.

We can not use the same GetScalarAttribute() construct since the compiler will not be able to resolve between SetAttribute(..., int) and SetAttribute(..., unsigned long).

◆ SetDoubleAttribute()

void vtkXMLDataElement::SetDoubleAttribute	(	const char *	name,
		double	value
	)

Set the attribute with the given name.

We can not use the same GetScalarAttribute() construct since the compiler will not be able to resolve between SetAttribute(..., int) and SetAttribute(..., unsigned long).

◆ SetUnsignedLongAttribute()

void vtkXMLDataElement::SetUnsignedLongAttribute	(	const char *	name,
		unsigned long	value
	)

Set the attribute with the given name.

We can not use the same GetScalarAttribute() construct since the compiler will not be able to resolve between SetAttribute(..., int) and SetAttribute(..., unsigned long).

◆ GetVectorAttribute() [1/7]

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

Get the attribute with the given name and converted to a scalar value.

Returns length of vector read.

◆ GetVectorAttribute() [2/7]

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

Get the attribute with the given name and converted to a scalar value.

Returns length of vector read.

◆ GetVectorAttribute() [3/7]

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

Get the attribute with the given name and converted to a scalar value.

Returns length of vector read.

◆ GetVectorAttribute() [4/7]

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

Get the attribute with the given name and converted to a scalar value.

Returns length of vector read.

◆ GetVectorAttribute() [5/7]

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

Get the attribute with the given name and converted to a scalar value.

Returns length of vector read.

◆ SetVectorAttribute() [1/6]

void vtkXMLDataElement::SetVectorAttribute	(	const char *	name,
		int	length,
		const int *	value
	)

Set the attribute with the given name.

◆ SetVectorAttribute() [2/6]

void vtkXMLDataElement::SetVectorAttribute	(	const char *	name,
		int	length,
		const float *	value
	)

Set the attribute with the given name.

◆ SetVectorAttribute() [3/6]

void vtkXMLDataElement::SetVectorAttribute	(	const char *	name,
		int	length,
		const double *	value
	)

Set the attribute with the given name.

◆ SetVectorAttribute() [4/6]

void vtkXMLDataElement::SetVectorAttribute	(	const char *	name,
		int	length,
		const unsigned long *	value
	)

Set the attribute with the given name.

◆ GetScalarAttribute() [6/7]

int vtkXMLDataElement::GetScalarAttribute	(	const char *	name,
		long long &	value
	)

◆ GetVectorAttribute() [6/7]

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

◆ SetVectorAttribute() [5/6]

void vtkXMLDataElement::SetVectorAttribute	(	const char *	name,
		int	length,
		long long const *	value
	)

◆ GetScalarAttribute() [7/7]

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

◆ GetVectorAttribute() [7/7]

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

◆ SetVectorAttribute() [6/6]

void vtkXMLDataElement::SetVectorAttribute	(	const char *	name,
		int	length,
		unsigned long long const *	value
	)

◆ GetWordTypeAttribute()

int vtkXMLDataElement::GetWordTypeAttribute	(	const char *	name,
		int &	value
	)

Get the attribute with the given name and converted to a word type.

Word types can be VTK_TYPE_FLOAT32, VTK_TYPE_FLOAT64, VTK_INT8, VTK_UINT8, VTK_INT16, VTK_UINT16, VTK_INT32, VTK_UINT32, VTK_INT64, VTK_UINT64, VTK_STRING, or VTK_BIT.

◆ GetNumberOfAttributes()

virtual int vtkXMLDataElement::GetNumberOfAttributes ( )

virtual

Get the number of attributes.

◆ GetAttributeName()

const char * vtkXMLDataElement::GetAttributeName ( int idx )

Get the n-th attribute name.

Returns 0 if there is no such attribute.

◆ GetAttributeValue()

const char * vtkXMLDataElement::GetAttributeValue ( int idx )

Get the n-th attribute value.

Returns 0 if there is no such attribute.

◆ RemoveAttribute()

virtual void vtkXMLDataElement::RemoveAttribute ( const char * name )

virtual

Remove one or all attributes.

◆ RemoveAllAttributes()

virtual void vtkXMLDataElement::RemoveAllAttributes ( )

virtual

Remove one or all attributes.

◆ GetParent()

vtkXMLDataElement * vtkXMLDataElement::GetParent ( )

Set/Get the parent of this element.

◆ SetParent()

void vtkXMLDataElement::SetParent ( vtkXMLDataElement * parent )

Set/Get the parent of this element.

◆ GetRoot()

virtual vtkXMLDataElement * vtkXMLDataElement::GetRoot ( )

virtual

Get root of the XML tree this element is part of.

◆ GetNumberOfNestedElements()

int vtkXMLDataElement::GetNumberOfNestedElements ( )

Get the number of elements nested in this one.

◆ GetNestedElement()

vtkXMLDataElement * vtkXMLDataElement::GetNestedElement ( int index )

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

◆ AddNestedElement()

void vtkXMLDataElement::AddNestedElement ( vtkXMLDataElement * element )

Add nested element.

◆ RemoveNestedElement()

virtual void vtkXMLDataElement::RemoveNestedElement ( vtkXMLDataElement * )

virtual

Remove nested element.

◆ RemoveAllNestedElements()

virtual void vtkXMLDataElement::RemoveAllNestedElements ( )

virtual

Remove all nested elements.

◆ FindNestedElement()

vtkXMLDataElement * vtkXMLDataElement::FindNestedElement ( const char * id )

Find the first nested element with the given id, given name, or given name and id.

WARNING: the search is only performed on the children, not the grand-children.

◆ FindNestedElementWithName()

vtkXMLDataElement * vtkXMLDataElement::FindNestedElementWithName ( const char * name )

Find the first nested element with the given id, given name, or given name and id.

WARNING: the search is only performed on the children, not the grand-children.

◆ FindNestedElementWithNameAndId()

vtkXMLDataElement * vtkXMLDataElement::FindNestedElementWithNameAndId	(	const char *	name,
		const char *	id
	)

Find the first nested element with the given id, given name, or given name and id.

WARNING: the search is only performed on the children, not the grand-children.

◆ FindNestedElementWithNameAndAttribute()

vtkXMLDataElement * vtkXMLDataElement::FindNestedElementWithNameAndAttribute	(	const char *	name,
		const char *	att_name,
		const char *	att_value
	)

Find the first nested element with the given id, given name, or given name and id.

WARNING: the search is only performed on the children, not the grand-children.

◆ LookupElementWithName()

vtkXMLDataElement * vtkXMLDataElement::LookupElementWithName ( const char * name )

Find the first nested element with given name.

WARNING: the search is performed on the whole XML tree.

◆ LookupElement()

vtkXMLDataElement * vtkXMLDataElement::LookupElement ( const char * id )

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

◆ GetXMLByteIndex()

virtual vtkTypeInt64 vtkXMLDataElement::GetXMLByteIndex ( )

virtual

Set/Get the offset from the beginning of the XML document to this element.

◆ SetXMLByteIndex()

virtual void vtkXMLDataElement::SetXMLByteIndex ( vtkTypeInt64 )

virtual

Set/Get the offset from the beginning of the XML document to this element.

◆ IsEqualTo()

virtual int vtkXMLDataElement::IsEqualTo ( vtkXMLDataElement * elem )

virtual

Check if the instance has the same name, attributes, character data and nested elements contents than the given element (this method is applied recursively on the nested elements, and they must be stored in the same order).

Warning: Id, Parent, XMLByteIndex are ignored.

◆ DeepCopy()

virtual void vtkXMLDataElement::DeepCopy ( vtkXMLDataElement * elem )

virtual

Copy this element from another of the same type (elem), recursively.

Old attributes and nested elements are removed, new ones are created given the contents of 'elem'. Warning: Parent is ignored.

◆ SetAttributeEncoding()

virtual void vtkXMLDataElement::SetAttributeEncoding ( int )

virtual

Get/Set the internal character encoding of the attributes.

Default type is VTK_ENCODING_UTF_8. Note that a vtkXMLDataParser has its own AttributesEncoding ivar. If this ivar is set to something other than VTK_ENCODING_NONE, it will be used to set the attribute encoding of each vtkXMLDataElement created by this vtkXMLDataParser.

◆ GetAttributeEncoding()

virtual int vtkXMLDataElement::GetAttributeEncoding ( )

virtual

Get/Set the internal character encoding of the attributes.

Default type is VTK_ENCODING_UTF_8. Note that a vtkXMLDataParser has its own AttributesEncoding ivar. If this ivar is set to something other than VTK_ENCODING_NONE, it will be used to set the attribute encoding of each vtkXMLDataElement created by this vtkXMLDataParser.

◆ PrintXML() [1/2]

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

Prints element tree as XML.

◆ PrintXML() [2/2]

void vtkXMLDataElement::PrintXML ( VTK_FILEPATH const char * fname )

Prints element tree as XML.

◆ GetCharacterDataWidth()

virtual int vtkXMLDataElement::GetCharacterDataWidth ( )

virtual

Get/Set the width (in number of fields) that character data (that between open and closing tags ie.

<X> ... </X>) is printed. If the width is less than one the tag's character data is printed all on one line. If it is greater than one the character data is streamed insterting line feeds every width number of fields. See PrintXML.

◆ SetCharacterDataWidth()

virtual void vtkXMLDataElement::SetCharacterDataWidth ( int )

virtual

Get/Set the width (in number of fields) that character data (that between open and closing tags ie.

<X> ... </X>) is printed. If the width is less than one the tag's character data is printed all on one line. If it is greater than one the character data is streamed insterting line feeds every width number of fields. See PrintXML.

◆ GetInlineDataPosition()

virtual vtkTypeInt64 vtkXMLDataElement::GetInlineDataPosition ( )

protectedvirtual

◆ SetInlineDataPosition()

virtual void vtkXMLDataElement::SetInlineDataPosition ( vtkTypeInt64 )

protectedvirtual

◆ LookupElementInScope()

vtkXMLDataElement * vtkXMLDataElement::LookupElementInScope ( const char * id )

protected

◆ LookupElementUpScope()

vtkXMLDataElement * vtkXMLDataElement::LookupElementUpScope ( const char * id )

protected

◆ IsSpace()

static int vtkXMLDataElement::IsSpace ( char c )

staticprotected

◆ PrintCharacterData()

void vtkXMLDataElement::PrintCharacterData	(	ostream &	os,
		vtkIndent	indent
	)

protected

◆ PrintWithEscapedData()

static void vtkXMLDataElement::PrintWithEscapedData	(	ostream &	os,
		const char *	data
	)

staticprotected

Friends And Related Function Documentation

◆ vtkXMLDataParser

friend class vtkXMLDataParser

friend

Definition at line 341 of file vtkXMLDataElement.h.

◆ vtkXMLMaterialParser

friend class vtkXMLMaterialParser

friend

Definition at line 342 of file vtkXMLDataElement.h.

Member Data Documentation

◆ Name

char* vtkXMLDataElement::Name

protected

Definition at line 296 of file vtkXMLDataElement.h.

◆ Id

char* vtkXMLDataElement::Id

protected

Definition at line 298 of file vtkXMLDataElement.h.

◆ CharacterDataWidth

int vtkXMLDataElement::CharacterDataWidth

protected

Definition at line 300 of file vtkXMLDataElement.h.

◆ CharacterData

char* vtkXMLDataElement::CharacterData

protected

Definition at line 303 of file vtkXMLDataElement.h.

◆ CharacterDataBlockSize

size_t vtkXMLDataElement::CharacterDataBlockSize

protected

Definition at line 304 of file vtkXMLDataElement.h.

◆ CharacterDataBufferSize

size_t vtkXMLDataElement::CharacterDataBufferSize

protected

Definition at line 305 of file vtkXMLDataElement.h.

◆ EndOfCharacterData

size_t vtkXMLDataElement::EndOfCharacterData

protected

Definition at line 306 of file vtkXMLDataElement.h.

◆ IgnoreCharacterData

int vtkXMLDataElement::IgnoreCharacterData

protected

Definition at line 310 of file vtkXMLDataElement.h.

◆ InlineDataPosition

vtkTypeInt64 vtkXMLDataElement::InlineDataPosition

protected

Definition at line 316 of file vtkXMLDataElement.h.

◆ XMLByteIndex

vtkTypeInt64 vtkXMLDataElement::XMLByteIndex

protected

Definition at line 318 of file vtkXMLDataElement.h.

◆ AttributeNames

char** vtkXMLDataElement::AttributeNames

protected

Definition at line 321 of file vtkXMLDataElement.h.

◆ AttributeValues

char** vtkXMLDataElement::AttributeValues

protected

Definition at line 322 of file vtkXMLDataElement.h.

◆ NumberOfAttributes

int vtkXMLDataElement::NumberOfAttributes

protected

Definition at line 323 of file vtkXMLDataElement.h.

◆ AttributesSize

int vtkXMLDataElement::AttributesSize

protected

Definition at line 324 of file vtkXMLDataElement.h.

◆ AttributeEncoding

int vtkXMLDataElement::AttributeEncoding

protected

Definition at line 325 of file vtkXMLDataElement.h.

◆ NumberOfNestedElements

int vtkXMLDataElement::NumberOfNestedElements

protected

Definition at line 328 of file vtkXMLDataElement.h.

◆ NestedElementsSize

int vtkXMLDataElement::NestedElementsSize

protected

Definition at line 329 of file vtkXMLDataElement.h.

◆ NestedElements

vtkXMLDataElement** vtkXMLDataElement::NestedElements

protected

Definition at line 330 of file vtkXMLDataElement.h.

◆ Parent

vtkXMLDataElement* vtkXMLDataElement::Parent

protected

Definition at line 332 of file vtkXMLDataElement.h.

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

Common/DataModel/vtkXMLDataElement.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkXMLDataElement()

◆ ~vtkXMLDataElement()

Member Function Documentation

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ New()

◆ GetName()

◆ SetName()

◆ GetId()

◆ SetId()

◆ GetAttribute()

◆ SetAttribute()

◆ SetCharacterData()

◆ AddCharacterData()

◆ GetCharacterData()

◆ GetScalarAttribute() [1/7]

◆ GetScalarAttribute() [2/7]

◆ GetScalarAttribute() [3/7]

◆ GetScalarAttribute() [4/7]

◆ GetScalarAttribute() [5/7]

◆ SetIntAttribute()

◆ SetFloatAttribute()

◆ SetDoubleAttribute()

◆ SetUnsignedLongAttribute()

◆ GetVectorAttribute() [1/7]

◆ GetVectorAttribute() [2/7]

◆ GetVectorAttribute() [3/7]

◆ GetVectorAttribute() [4/7]

◆ GetVectorAttribute() [5/7]

◆ SetVectorAttribute() [1/6]

◆ SetVectorAttribute() [2/6]

◆ SetVectorAttribute() [3/6]

◆ SetVectorAttribute() [4/6]

◆ GetScalarAttribute() [6/7]

◆ GetVectorAttribute() [6/7]

◆ SetVectorAttribute() [5/6]

◆ GetScalarAttribute() [7/7]

◆ GetVectorAttribute() [7/7]

◆ SetVectorAttribute() [6/6]

◆ GetWordTypeAttribute()

◆ GetNumberOfAttributes()

◆ GetAttributeName()

◆ GetAttributeValue()

◆ RemoveAttribute()

◆ RemoveAllAttributes()

◆ GetParent()

◆ SetParent()

◆ GetRoot()

◆ GetNumberOfNestedElements()

◆ GetNestedElement()

◆ AddNestedElement()

◆ RemoveNestedElement()

◆ RemoveAllNestedElements()

◆ FindNestedElement()

◆ FindNestedElementWithName()

◆ FindNestedElementWithNameAndId()

◆ FindNestedElementWithNameAndAttribute()

◆ LookupElementWithName()

◆ LookupElement()

◆ GetXMLByteIndex()

◆ SetXMLByteIndex()

◆ IsEqualTo()

◆ DeepCopy()

◆ SetAttributeEncoding()

◆ GetAttributeEncoding()