InputContext Class Reference

Class representing a resource context for gearbox. More...

#include <InputHandler.h>

Inheritance diagram for InputContext:

Public Member Functions
virtual int	readXmlData (char *buffer, int buffsize)=0
	Read a block of XML data into buffer, at most buffsize bytes and return the number of bytes read.
virtual	~InputContext ()
	Close the context.

Detailed Description

Class representing a resource context for gearbox.

This class is responsible for providing read access to an XML resource and to free any memory associated with the resource on destruction

Definition at line 25 of file InputHandler.h.

Constructor & Destructor Documentation

~InputContext()

virtual ~InputContext ( )

inlinevirtual

Close the context.

Definition at line 37 of file InputHandler.h.

{}

Member Function Documentation

readXmlData()

virtual int readXmlData ( char *  buffer, int  buffsize  )

pure virtual

Read a block of XML data into buffer, at most buffsize bytes and return the number of bytes read.

Parameters

buffer	pointer where to write XML data
buffsize	number of bytes to write, actual number of bytes can be less if XML is shorter

Returns

number of bytes actually written

Implemented in FileContext, and StringContext.

---

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

• framework/gearbox/include/InputHandler.h