IlXmlCharRef Class Reference

Default implementation of XML CharRefs. More...

#include <ilog/xml.h>

Inheritance diagram for IlXmlCharRef:

Public Member Functions
virtual int	getRefCode () const
	Retrieves the character code. More...
virtual const char *	getRefName () const
	Retrieves the name of this CharRef. More...
virtual void	setRefCode (int code)
	Sets the character code. More...
virtual void	storeRefName (char *)
	Sets the CharRef name. More...
Public Member Functions inherited from IlXmlCharRefI
virtual Type	getType () const
	Retrieves the type of this element. More...
virtual void	setRefName (const char *name)
	Sets the CharRef name. More...
Public Member Functions inherited from IlXmlNodeI
virtual std::ostream &	write (std::ostream &stream) const =0
	Writes the XML code for this node. More...

Additional Inherited Members
Public Types inherited from IlXmlNodeI
enum	Type {   Attribute, Element, Text, Comment,   CData, PI, CharRef, EntityRef }
	The different types of XML nodes. More...

Detailed Description

Default implementation of XML CharRefs.

Library: ilog

This class implements the interface IlXmlCharRefI to provide the basic functionality of XML CharRef or EntityRef nodes.

Member Function Documentation

getRefCode()

virtual int IlXmlCharRef::getRefCode ( ) const

virtual

Retrieves the character code.

Returns

The character code, or 0 if this CharRef does not correspond to a code (then getRefName() returns a meaningful value).

See also

getRefName().

Implements IlXmlCharRefI.

getRefName()

virtual const char* IlXmlCharRef::getRefName ( ) const

virtual

Retrieves the name of this CharRef.

Returns

The name of this CharRef. The user must not modify or delete the returned string. This is meaningful only if this CharRef does not correspond to a character code.

Implements IlXmlCharRefI.

setRefCode()

virtual void IlXmlCharRef::setRefCode ( int  code )

virtual

Sets the character code.

Parameters

code	The new character code for this CharRef.

Implements IlXmlCharRefI.

storeRefName()

virtual void IlXmlCharRef::storeRefName ( char *  name )

virtual

Sets the CharRef name.

Parameters

name	The new name of this CharRef. This string is not copied before it is stored.

Implements IlXmlCharRefI.