Application coding

---

Detailed Description

A Qgar application is a piece of code to be run either from a command line or from the QgarGui user interface. It must be associated with a XML file describing the application itself (basic method, results, etc.) and its parameters. Once both code and XML files are stored into a specific subdirectory of directory QgarApps, the application is automatically integrated into the user's environment when the QgarGui user interface is launched.

qgar::QgarApp and qgar::QgarArgs are the classes to get acquainted with. See class qgar::QgarApp (or any application in the QgarApps directory) for an example of the way to code a Qgar application.

Users are not concerned with the other classes and data (qgar::QgarAppDescr, qgar::QgarAppParamDescr, inner classes...)

Classes
struct	qgar::QgarAppDescr::ParseData
	Structure holding all the data used while parsing. Using a structure to regroup all these data allows to dynamically allocate the room to store it. This space can the be desallocated when parsing is over. This means the that the overall memory cost for these data is 1 pointer size when no parsing is performed. More...
class	qgar::QgarApp
	To handle parameters and interactive mode of an application. More...
class	qgar::QgarAppDescr
	Parses an XML description of a Qgar application and builds its representation. More...
class	qgar::QgarAppParamDescr
	Memory representation of an application parameter description. More...
class	qgar::QgarArgs
	To handle the parameters given to an application. More...
class	qgar::QgarArgs::QgarParam
	Internal representation of an application parameter. More...
Data Used for Parsing
qgar::QgarAppDescr::ParseData *	qgar::QgarAppDescr::_parseData
	Structure holding all the data used while parsing. Using a structure to regroup all these data allows to dynamically allocate the room to store it. This space can the be desallocated when parsing is over. This means the that the overall memory cost for these data is 1 pointer size when no parsing is performed. A pointer to the struct holding parsing data.

---

Variable Documentation

struct qgar::QgarAppDescr::ParseData * qgar::QgarAppDescr::_parseData [protected, inherited]

Structure holding all the data used while parsing. Using a structure to regroup all these data allows to dynamically allocate the room to store it. This space can the be desallocated when parsing is over. This means the that the overall memory cost for these data is 1 pointer size when no parsing is performed. A pointer to the struct holding parsing data. For internal use only. Referenced by qgar::QgarAppDescr::characters(), qgar::QgarAppDescr::endAuthor(), qgar::QgarAppDescr::endBrief(), qgar::QgarAppDescr::endCopyright(), qgar::QgarAppDescr::endLong(), qgar::QgarAppDescr::endName(), qgar::QgarAppDescr::endParam(), qgar::QgarAppDescr::operator=(), qgar::QgarAppDescr::QgarAppDescr(), qgar::QgarAppDescr::startParam(), and qgar::QgarAppDescr::~QgarAppDescr().