IlXmlCharRefI Class Reference

Interface for XML CharRefs. More...

#include <ilog/xml.h>

Inheritance diagram for IlXmlCharRefI:

List of all members.

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

---

Detailed Description

Interface for XML CharRefs.

Library: ilog

This class is an interface that describes an XML character reference node.

---

Member Function Documentation

virtual int IlXmlCharRefI::getRefCode

(

)

const [pure 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.

Implemented in IlXmlCharRef.

virtual const char* IlXmlCharRefI::getRefName

(

)

const [pure 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.

Implemented in IlXmlCharRef.

virtual Type IlXmlCharRefI::getType

(

)

const [virtual]

Retrieves the type of this element.

Returns:

The type of this element.

Implements IlXmlNodeI.

virtual void IlXmlCharRefI::setRefCode

(

int

code

)

[pure virtual]

Sets the character code.

Parameters:

code

The new character code for this CharRef.

Implemented in IlXmlCharRef.

virtual void IlXmlCharRefI::setRefName

(

const char *

name

)

[virtual]

Sets the CharRef name.

Parameters:

name

The new name of this CharRef. The default implementation calls storeRefName with a copy of the string name.

virtual void IlXmlCharRefI::storeRefName

(

char *

name

)

[pure virtual]

Sets the CharRef name.

Parameters:

comment

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

Implemented in IlXmlCharRef.

virtual ostream& IlXmlCharRefI::write

(

ostream &

stream

)

const [virtual]

Writes the XML code for this node.

Each subclass of this class implements its own version of write, depending on its type.

Parameters:

stream

The output stream where the XML code will be sent.

Returns:

A reference to the provided output stream.

Implements IlXmlNodeI.