Views
Foundation Package API Reference Guide
Product Documentation:
Views Documentation Home
List of all members | Public Types | Public Member Functions
IlXmlNodeI Class Referenceabstract

Interface for XML nodes. More...

#include <ilog/xml.h>

Inheritance diagram for IlXmlNodeI:
IlXmlAttributeI IlXmlCDataI IlXmlCharRefI IlXmlCommentI IlXmlElementI IlXmlPII IlXmlTextI IlXmlAttribute IlXmlCData IlXmlCharRef IlXmlComment IlXmlElement IlXmlPI IlXmlText

Public Types

enum  Type {
  Attribute, Element, Text, Comment,
  CData, PI, CharRef, EntityRef
}
 The different types of XML nodes. More...
 

Public Member Functions

virtual Type getType () const =0
 Retrieves the type of this element. More...
 
virtual std::ostream & write (std::ostream &stream) const =0
 Writes the XML code for this node. More...
 

Detailed Description

Interface for XML nodes.

Library: ilog

Every entity that is parsed in an XML stream is converted to an instance of a subclass of IlXmlNodeI.
There are several subclasses of this interface, to handle the different entity types:

Member Enumeration Documentation

◆ Type

The different types of XML nodes.

Enumerator
Attribute 

The node is an Attribute.

Element 

The node is an Element.

Text 

The node is a Text.

Comment 

The node is a Comment.

CData 

The node is a Char Data.

PI 

The node is a Processing Instruction.

CharRef 

The node is a Character Reference.

EntityRef 

The node is an Entity Reference.

Member Function Documentation

◆ getType()

virtual Type IlXmlNodeI::getType ( ) const
pure virtual

Retrieves the type of this element.

Returns
The type of this element.

Implemented in IlXmlCharRefI, IlXmlCDataI, IlXmlPII, IlXmlTextI, IlXmlCommentI, IlXmlElementI, and IlXmlAttributeI.

◆ write()

virtual std::ostream& IlXmlNodeI::write ( std::ostream &  stream) const
pure virtual

Writes the XML code for this node.

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

Parameters
streamThe output stream where the XML code will be sent.
Returns
A reference to the provided output stream.

Implemented in IlXmlAttributeI, and IlXmlElementI.