amn::IReadFileXML Class Reference

XML file reading class. More...

#include <IReadFileXML.h>

Inheritance diagram for amn::IReadFileXML:

List of all members.

Public Member Functions
	IReadFileXML (const char *filename, IFileManager *manager)
virtual	~IReadFileXML ()
virtual bool	isOpen ()=0
	Returns true if the file was successfully opened.
virtual void	close ()=0
	Close the file.
virtual bool	read ()=0
virtual E_XML_CHUNK	getChunkType ()=0
	Returns the type of chunk read.
virtual std::string &	getTagName ()=0
	Returns the beginning/end tag name.
virtual std::string &	getText ()=0
virtual int	getAttributeCount ()=0
	Returns the number of attributes in the beginning tag.
virtual std::string &	getAttributeValue (int attributeNumber)=0
	Returns the value of an attribute.
virtual std::string &	getAttributeValue (const char *attributeName)=0
	Returns the value of an attribute by attribute name.
virtual int	getAttributeValueAsInt (int attributeNumber)=0
	Returns the value of an attribute as an integer.
virtual int	getAttributeValueAsInt (const char *attributeName)=0
	Returns the value of an attribute as an integer.
virtual float	getAttributeValueAsFloat (int attributeNumber)=0
	Returns the value of an attribute as a floating-point decimal.
virtual float	getAttributeValueAsFloat (const char *attributeName)=0
	Returns the value of an attribute as a floating-point decimal.
Protected Attributes
IFileManager *	fileManager

---

Detailed Description

XML file reading class.

---

Constructor & Destructor Documentation

amn::IReadFileXML::IReadFileXML (  const char *  filename, IFileManager *  manager )  [inline]

virtual amn::IReadFileXML::~IReadFileXML (   )  [inline, virtual]

---

Member Function Documentation

virtual void amn::IReadFileXML::close (   )  [pure virtual]

Close the file.

virtual int amn::IReadFileXML::getAttributeCount (   )  [pure virtual]

Returns the number of attributes in the beginning tag.

virtual std::string& amn::IReadFileXML::getAttributeValue (  const char *  attributeName  )  [pure virtual]

Returns the value of an attribute by attribute name.

virtual std::string& amn::IReadFileXML::getAttributeValue (  int  attributeNumber  )  [pure virtual]

Returns the value of an attribute.

virtual float amn::IReadFileXML::getAttributeValueAsFloat (  const char *  attributeName  )  [pure virtual]

Returns the value of an attribute as a floating-point decimal.

virtual float amn::IReadFileXML::getAttributeValueAsFloat (  int  attributeNumber  )  [pure virtual]

Returns the value of an attribute as a floating-point decimal.

virtual int amn::IReadFileXML::getAttributeValueAsInt (  const char *  attributeName  )  [pure virtual]

Returns the value of an attribute as an integer.

virtual int amn::IReadFileXML::getAttributeValueAsInt (  int  attributeNumber  )  [pure virtual]

Returns the value of an attribute as an integer.

virtual E_XML_CHUNK amn::IReadFileXML::getChunkType (   )  [pure virtual]

Returns the type of chunk read.

virtual std::string& amn::IReadFileXML::getTagName (   )  [pure virtual]

Returns the beginning/end tag name.

virtual std::string& amn::IReadFileXML::getText (   )  [pure virtual]

Returns the text. See also: getChunkType() EXC_TEXT Returns: Returns a STD string containing the text.

virtual bool amn::IReadFileXML::isOpen (   )  [pure virtual]

Returns true if the file was successfully opened.

virtual bool amn::IReadFileXML::read (   )  [pure virtual]

Reads the next chunk of XML. Returns: True if chunk successfully read. False otherwise.

---

Member Data Documentation

IFileManager* amn::IReadFileXML::fileManager [protected]

---

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

• includes/IReadFileXML.h

---