qgar::QgarAppDescr Class Reference
[Application coding]

#include <qgarlib/QgarAppDescr.H>

Inheritance diagram for qgar::QgarAppDescr:

List of all members.

---

Detailed Description

Parses an XML description of a Qgar application and builds its representation.

Each Qgar application is linked to an XML document containing its description and the description of its parameter.

The main elements of the description are:

• its name
• its author
• the copyright attached to it
• its documentation
• the description of each of its parameters.

This class allows the user to create a representation of such a description by taking care of the parsing of the XML document. Once this representation is created, the user can query the various elements composing the description.

Each parameter description is stored into an instance of class qgar::QgarAppParamDescr.

The user may also serialize instances of this class to XML using the qgar::QgarAppDescr::toXml() function member.

Todo:

Insert a link to the document DTD.

See also:

Class qgar::QgarAppParamDescr

Author:

Jan Rendek

Date:

May 14, 2003 15:29

Since:

Qgar 2.1.1

Definition at line 112 of file QgarAppDescr.H.

Data Used for Parsing
enum	ParseState {   MAIN,   PARAM }
qgar::QgarAppDescr::ParseData *	_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.
Public Member Functions
Constructors
	QgarAppDescr (const char *const filename) throw (std::runtime_error)
	Build a QgarAppDescr from a file.
	QgarAppDescr (const std::string &filename) throw (std::runtime_error)
	Build a QgarAppDescr from a string.
	QgarAppDescr (std::istream &stream) throw (std::runtime_error)
	Build a QgarAppDescr from an input stream.
	QgarAppDescr (const std::string &name, const std::string &copyright, const std::string &briefDoc, const std::string &longDoc, const std::vector< QgarAppParamDescr * > &paramVect)
	Build a QgarAppDescr from given data.
	QgarAppDescr (const QgarAppDescr &)
	Copy constructor.
Destructors
virtual	~QgarAppDescr ()
	Destructor.
Parameters
void	addParamDescr (QgarAppParamDescr *descr)
	Add the description of a parameter.
XML Serialization
std::string	toXml () const
	Builds an XML document representating this application description.
DefaultHandler Redefinitions
virtual void	characters (const char *ch, const unsigned int start, const unsigned int length)
virtual void	startElement (const std::string &uri, const std::string &localName, const std::string &qName, const qgxml::Attributes &atts)
virtual void	endElement (const std::string &uri, const std::string &localName, const std::string &qName)
virtual void	fatalError (const qgxml::SAXParseException &exception)
Access
std::string	name () const
	Retrieve the name of the application.
std::string	author () const
	Retrieve the author of the application.
std::string	copyright () const
	Retrieve the copyright notice attached to the application.
std::string	briefDoc () const
	Retrieve the brief documentation of the application.
std::string	longDoc () const
	Retrieve the detailed documentation for the application.
std::vector< QgarAppParamDescr * >	paramVect () const
	Retrieve the description of the parameters of the application.
const std::string &	accessName () const
	Access to the name of the application.
const std::string &	accessAuthor () const
	Access to the author information of the application.
const std::string &	accessCopyright () const
	Access to the copyright notice attached to the application.
const std::string &	accessBriefDoc () const
	Access to the brief documentation of the application.
const std::string &	accessLongDoc () const
	Access to the detailed documentation of the application.
const std::vector< QgarAppParamDescr * > &	accessParamVect () const
	Access to the descriptions of the parameters of the application.
Transformation
void	setName (const std::string &name)
	Sets the name of the application.
void	setAuthor (const std::string &author)
	Sets the name of the author of the application.
void	setCopyright (const std::string &copyright)
	Sets the copyright notice for the application.
void	setBriefDoc (const std::string &briefDoc)
	Sets the brief documentation of the application.
void	setLongDoc (const std::string &longDoc)
	Sets the detailed documentation of the application.
void	setParamVect (const std::vector< QgarAppParamDescr * > &paramVect)
	Sets the descriptions of the application parameters.
Operators
QgarAppDescr &	operator= (const QgarAppDescr &rhs)
	Assignment operator.
ContentHandler Impl
virtual void	endDocument ()
	Receive notification of the end of a document.
virtual void	endPrefixMapping (const std::string &prefix)
	End the scope of a prefix-URI mapping.
virtual void	ignorableWhitespace (const char *ch, const unsigned int start, const unsigned int length)
	Receive notification of ignorable whitespace in element content.
virtual void	processingInstruction (const std::string &target, const std::string &data)
	Receive notification of a processing instruction.
virtual void	setDocumentLocator (Locator *locator)
	Receive an object for locating the origin of SAX document events.
virtual void	skippedEntity (const std::string &name)
	Receive notification of a skipped entity.
virtual void	startDocument ()
	Receive notification of the beginning of a document.
virtual void	startPrefixMapping (const std::string &prefix, const std::string &uri)
	Begin the scope of a prefix-URI Namespace mapping.
DTDHandler Impl
virtual void	notationDecl (const std::string &name, const std::string &publicId, const std::string &systemId)
	Receive notification of a notation declaration event.
virtual void	unparsedEntityDecl (const std::string &name, const std::string &publicId, const std::string &systemId, const std::string &notationName)
	Receive notification of an unparsed entity declaration event.
EntityResolver Impl
virtual InputSource *	resolveEntity (const std::string &publicId, const std::string &systemId)
	Allow the application to resolve external entities.
ErrorHandler Impl
virtual void	error (const SAXParseException &exception)
	Receive notification of a recoverable error.
virtual void	warning (const SAXParseException &exception)
	Receive notification of a warning.
Static Public Attributes
TAGs
The tags composing the XML document describing an application description.
static const char *const	ELT_APPLICATION = "application"
static const char *const	ELT_DESCR = "descr"
static const char *const	ELT_DOCUMENTATION = "documentation"
static const char *const	ELT_PARAMLIST = "paramlist"
static const char *const	ELT_PARAM = "param"
static const char *const	ELT_NAME = "name"
static const char *const	ELT_AUTHOR = "author"
static const char *const	ELT_COPYRIGHT = "copyright"
static const char *const	ELT_DOC = "doc"
static const char *const	ELT_BRIEF = "brief"
static const char *const	ELT_LONG = "long"
static const char *const	ATT_REVISION = "revision"
static const char *const	ATT_LANG = "lang"
static const char *const	ATT_NAME = "name"
static const char *const	ATT_FLAG = "flag"
static const char *const	ATT_REQUIRED = "required"
static const char *const	ATT_PASSING_MODE = "passing-mode"
static const char *const	ATT_FORMAT = "format"
static const char *const	ATT_TYPE = "type"
Protected Member Functions
void	init (qgxml::InputSource source) throw (std::runtime_error)
	Creates an instance from an XML document located by an input source.
Methods used for parsing elements
Theses methods are callbacks invoked from the DefaultHandler function members implementations. For internal use only.
void	startParam (const qgxml::Attributes &atts)
	Callback invoked when the parser starts parsing a new parameter section.
void	endParam ()
	Callback invoked when the parser has finished the parsing of a parameter section.
void	endName ()
	Callback invoked when the parser has finished the parsing of the name section.
void	endAuthor ()
	Callback invoked when the parser has finished the parsing of the author section.
void	endCopyright ()
	Callabck invoked when the parser has finished the parsing of the copyright section.
void	endBrief ()
	Callabck invoked when the parser has finished the parsing of the brief documentation section.
void	endLong ()
	Callabck invoked when the parser has finished the parsing of the detailed documentation section.
Protected Attributes
std::string	_name
	The name of the application.
std::string	_author
	The author of the application.
std::string	_copyright
	The copyright notice.
std::string	_briefDoc
	The brief documentation.
std::string	_longDoc
	The documentation verbose version.
std::vector< QgarAppParamDescr * >	_paramVect
	The descriptions of the application parameters.
Classes
struct	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...

---

Member Enumeration Documentation

enum qgar::QgarAppDescr::ParseState [protected]

For internal use only. Enumerator: MAIN  PARAM  Definition at line 589 of file QgarAppDescr.H.

---

Constructor & Destructor Documentation

qgar::QgarAppDescr::QgarAppDescr (  const char *const   filename  )  throw (std::runtime_error) [explicit]

Build a QgarAppDescr from a file. Parameters: filename  The file to create the description from. Definition at line 99 of file QgarAppDescr.C.

qgar::QgarAppDescr::QgarAppDescr (  const std::string &  filename  )  throw (std::runtime_error) [explicit]

Build a QgarAppDescr from a string. Parameters: filename  The name of the file containing the XML document to load the description from.

qgar::QgarAppDescr::QgarAppDescr (  std::istream &  stream  )  throw (std::runtime_error) [explicit]

Build a QgarAppDescr from an input stream. Parameters: stream  The input stream to parse the XML document from.

qgar::QgarAppDescr::QgarAppDescr (  const std::string &  name, const std::string &  copyright, const std::string &  briefDoc, const std::string &  longDoc, const std::vector< QgarAppParamDescr * > &  paramVect )

Build a QgarAppDescr from given data. Parameters: name  The name of the application. copyright  The copyright notice attached to the application. briefDoc  The brief documentation of this application. longDoc  The detailed documentation of this application. paramVect  The descriptions of the application parameters.

qgar::QgarAppDescr::QgarAppDescr (  const QgarAppDescr &   )

Copy constructor. Definition at line 160 of file QgarAppDescr.C. References _paramVect, and _parseData.

qgar::QgarAppDescr::~QgarAppDescr (   )  [virtual]

Destructor. Definition at line 186 of file QgarAppDescr.C. References _paramVect, and _parseData.

---

Member Function Documentation

const string & qgar::QgarAppDescr::accessAuthor (   )  const

Access to the author information of the application. Returns: A reference on the information about the author of the application or an empty string if no author was provided. Definition at line 403 of file QgarAppDescr.C. References _author.

const string & qgar::QgarAppDescr::accessBriefDoc (   )  const

Access to the brief documentation of the application. Returns: A reference on the brief documentation of the application, or on an empty string if no documentation was provided. Definition at line 418 of file QgarAppDescr.C. References _briefDoc.

const string & qgar::QgarAppDescr::accessCopyright (   )  const

Access to the copyright notice attached to the application. Returns: A reference on the copyright notice, or on an empty string if no notice was provided. Definition at line 410 of file QgarAppDescr.C. References _copyright.

const string & qgar::QgarAppDescr::accessLongDoc (   )  const

Access to the detailed documentation of the application. Returns: A reference on the detailed documentation of the application or on an empty string if no detailed documentation was provided. Definition at line 426 of file QgarAppDescr.C. References _longDoc.

const string & qgar::QgarAppDescr::accessName (   )  const

Access to the name of the application. Returns: A reference on the name of the application, or on an empty string if no name was provided. Definition at line 395 of file QgarAppDescr.C. References _name.

const vector< QgarAppParamDescr * > & qgar::QgarAppDescr::accessParamVect (   )  const

Access to the descriptions of the parameters of the application. Returns: A reference on the vector containing the memory representation of the parameters description, or an empty vector if the application has no parameter. Definition at line 434 of file QgarAppDescr.C. References _paramVect.

void qgar::QgarAppDescr::addParamDescr (  QgarAppParamDescr *  descr  )

Add the description of a parameter. Parameters: descr  the description of the parameter to be added Definition at line 201 of file QgarAppDescr.C. References _paramVect. Referenced by endParam().

string qgar::QgarAppDescr::author (   )  const

Retrieve the author of the application. Returns: The author of the application, or an empty string if no name was provided.. Definition at line 348 of file QgarAppDescr.C. References _author.

string qgar::QgarAppDescr::briefDoc (   )  const

Retrieve the brief documentation of the application. Returns: The brief documentation of the application, or an empty string if no documenation was provided. Definition at line 363 of file QgarAppDescr.C. References _briefDoc.

void qgar::QgarAppDescr::characters (  const char *  ch, const unsigned int  start, const unsigned int  length )  [virtual]

Todo: To be documented! Reimplemented from qgxml::DefaultHandler. Definition at line 249 of file QgarAppDescr.C. References _parseData, and qgar::QgarAppDescr::ParseData::buffer.

string qgar::QgarAppDescr::copyright (   )  const

Retrieve the copyright notice attached to the application. Returns: The copyright for the application, or an empty string if no notice was provided. Definition at line 355 of file QgarAppDescr.C. References _copyright.

void qgar::QgarAppDescr::endAuthor (   )  [protected]

Callback invoked when the parser has finished the parsing of the author section. For internal use only. The author section is enclosed in a pair of <ELT_AUTHOR> <ELT_AUTHOR/> tags. Definition at line 664 of file QgarAppDescr.C. References _parseData, qgar::QgarAppDescr::ParseData::buffer, and setAuthor().

void qgar::QgarAppDescr::endBrief (   )  [protected]

Callabck invoked when the parser has finished the parsing of the brief documentation section. For internal use only. The copyright section is enclosed in a pair of <ELT_BRIEF> <ELT_BRIEF/> tags. Definition at line 680 of file QgarAppDescr.C. References _parseData, qgar::QgarAppDescr::ParseData::buffer, qgar::QgarAppDescr::ParseData::currentParam, MAIN, setBriefDoc(), and qgar::QgarAppDescr::ParseData::state.

void qgar::QgarAppDescr::endCopyright (   )  [protected]

Callabck invoked when the parser has finished the parsing of the copyright section. For internal use only. The copyright section is enclosed in a pair of <ELT_COPYRIGHT> <ELT_COPYRIGHT/> tags. Definition at line 672 of file QgarAppDescr.C. References _parseData, qgar::QgarAppDescr::ParseData::buffer, and setCopyright().

virtual void qgxml::DefaultHandler::endDocument (   )  [inline, virtual, inherited]

Receive notification of the end of a document. The SAX parser will invoke this method only once, and it will be the last method invoked during the parse. The parser shall not invoke this method until it has either abandoned parsing (because of an unrecoverable error) or reached the end of input. See also: startDocument() Implements qgxml::ContentHandler. Definition at line 99 of file DefaultHandler.H.

virtual void qgar::QgarAppDescr::endElement (  const std::string &  uri, const std::string &  localName, const std::string &  qName )  [virtual]

Todo: To be documented! Reimplemented from qgxml::DefaultHandler.

void qgar::QgarAppDescr::endLong (   )  [protected]

Callabck invoked when the parser has finished the parsing of the detailed documentation section. For internal use only. The copyright section is enclosed in a pair of <ELT_LONG> <ELT_LONG/> tags. Definition at line 692 of file QgarAppDescr.C. References _parseData, qgar::QgarAppDescr::ParseData::buffer, qgar::QgarAppDescr::ParseData::currentParam, MAIN, setLongDoc(), and qgar::QgarAppDescr::ParseData::state.

void qgar::QgarAppDescr::endName (   )  [protected]

Callback invoked when the parser has finished the parsing of the name section. For internal use only. The name section is enclosed in a pair of <ELT_NAME> </ELT_NAME> tags. Definition at line 656 of file QgarAppDescr.C. References _parseData, qgar::QgarAppDescr::ParseData::buffer, and setName().

void qgar::QgarAppDescr::endParam (   )  [protected]

Callback invoked when the parser has finished the parsing of a parameter section. For internal use only. The parameter sections are enclosed by <ELT_PARAM> tags. See also: qgar::QgarAppDescr::startParam() Definition at line 645 of file QgarAppDescr.C. References _parseData, addParamDescr(), qgar::QgarAppDescr::ParseData::currentParam, MAIN, and qgar::QgarAppDescr::ParseData::state.

virtual void qgxml::DefaultHandler::endPrefixMapping (  const std::string &  prefix  )  [inline, virtual, inherited]

End the scope of a prefix-URI mapping. Parameters: prefix  The prefix that was being mapped. This is the empty string when a default mapping scope ends. See also: startPrefixMapping Implements qgxml::ContentHandler. Definition at line 109 of file DefaultHandler.H.

virtual void qgxml::DefaultHandler::error (  const SAXParseException &  exception  )  [inline, virtual, inherited]

Receive notification of a recoverable error. Parameters: exception  The error information encapsulated in a SAX parse exception. Implements qgxml::ErrorHandler. Definition at line 182 of file DefaultHandler.H.

void qgar::QgarAppDescr::fatalError (  const qgxml::SAXParseException &  exception  )  [virtual]

Todo: To be documented! Reimplemented from qgxml::DefaultHandler. Definition at line 330 of file QgarAppDescr.C. References qgxml::SAXException::getMessage().

virtual void qgxml::DefaultHandler::ignorableWhitespace (  const char *  ch, const unsigned int  start, const unsigned int  length )  [inline, virtual, inherited]

Receive notification of ignorable whitespace in element content. Parameters: ch  The characters from the XML document. start  The start position in the array. length  The number of characters to read from the array. Implements qgxml::ContentHandler. Definition at line 113 of file DefaultHandler.H.

void qgar::QgarAppDescr::init (  qgxml::InputSource  source  )  throw (std::runtime_error) [protected]

Creates an instance from an XML document located by an input source. Parameters: source  The input source referencing the XML document to create an instance from. Exceptions: std::runtime_error  This exception is thrown if the input source could not be accessed, or if an error occured while parsing the XML document. Definition at line 221 of file QgarAppDescr.C. References qgxml::XMLReader::parse(), and qgxml::XMLReader::setContentHandler().

string qgar::QgarAppDescr::longDoc (   )  const

Retrieve the detailed documentation for the application. Returns: The detailed documentation of the application, or an empty string if no documentation was provided. Definition at line 371 of file QgarAppDescr.C. References _longDoc.

string qgar::QgarAppDescr::name (   )  const

Retrieve the name of the application. Returns: The name of the applcation, or an empty string if no name was provided. Definition at line 340 of file QgarAppDescr.C. References _name.

virtual void qgxml::DefaultHandler::notationDecl (  const std::string &  name, const std::string &  publicId, const std::string &  systemId )  [inline, virtual, inherited]

Receive notification of a notation declaration event. Parameters: name  The notation name. publicId  The notation's public identifier. systemId  The notation's system identifier. Implements qgxml::DTDHandler. Definition at line 154 of file DefaultHandler.H.

QgarAppDescr & qgar::QgarAppDescr::operator= (  const QgarAppDescr &  rhs  )

Assignment operator. Definition at line 708 of file QgarAppDescr.C. References _briefDoc, _copyright, _longDoc, _name, _paramVect, and _parseData.

vector< QgarAppParamDescr * > qgar::QgarAppDescr::paramVect (   )  const

Retrieve the description of the parameters of the application. Returns: A vector containing the memory representation of the parameters description, or an empty vector if the application has no parameter. Definition at line 379 of file QgarAppDescr.C. References _paramVect.

virtual void qgxml::DefaultHandler::processingInstruction (  const std::string &  target, const std::string &  data )  [inline, virtual, inherited]

Receive notification of a processing instruction. Parameters: target  The processing instruction target. data  The processing instruction data. The data does not include any whitespace separating it from the target. Implements qgxml::ContentHandler. Definition at line 119 of file DefaultHandler.H.

virtual InputSource* qgxml::DefaultHandler::resolveEntity (  const std::string &  publicId, const std::string &  systemId )  [inline, virtual, inherited]

Allow the application to resolve external entities. Parameters: publicId  The public identifier of the external entity being referenced. systemId  The system identifier of the external entity being referenced. Returns: An InputSource object describing the new input source. Implements qgxml::EntityResolver. Definition at line 172 of file DefaultHandler.H.

void qgar::QgarAppDescr::setAuthor (  const std::string &  author  )

Sets the name of the author of the application. Parameters: author  The new name of the author(s) of the application. Referenced by endAuthor().

void qgar::QgarAppDescr::setBriefDoc (  const std::string &  briefDoc  )

Sets the brief documentation of the application. Parameters: briefDoc  The new brief documentation of the application. Referenced by endBrief().

void qgar::QgarAppDescr::setCopyright (  const std::string &  copyright  )

Sets the copyright notice for the application. Parameters: copyright  The new copyright notice for the application. Referenced by endCopyright().

virtual void qgxml::DefaultHandler::setDocumentLocator (  Locator *  locator  )  [inline, virtual, inherited]

Receive an object for locating the origin of SAX document events. Parameters: locator  An object that can return the location of any SAX document event. Implements qgxml::ContentHandler. Definition at line 124 of file DefaultHandler.H.

void qgar::QgarAppDescr::setLongDoc (  const std::string &  longDoc  )

Sets the detailed documentation of the application. Parameters: longDoc  The new detailed documentation of the application. Referenced by endLong().

void qgar::QgarAppDescr::setName (  const std::string &  name  )

Sets the name of the application. Parameters: name  The new name of the application. Referenced by endName().

void qgar::QgarAppDescr::setParamVect (  const std::vector< QgarAppParamDescr * > &  paramVect  )

Sets the descriptions of the application parameters. Parameters: paramVect  A vector containing the new descriptions of the application parameters.

virtual void qgxml::DefaultHandler::skippedEntity (  const std::string &  name  )  [inline, virtual, inherited]

Receive notification of a skipped entity. Parameters: name  The name of the skipped entity. Implements qgxml::ContentHandler. Definition at line 128 of file DefaultHandler.H.

virtual void qgxml::DefaultHandler::startDocument (   )  [inline, virtual, inherited]

Receive notification of the beginning of a document. The SAX parser will invoke this method only once, before any other event callbacks (except for setDocumentLocator()). See also: endDocument() Implements qgxml::ContentHandler. Definition at line 132 of file DefaultHandler.H.

virtual void qgar::QgarAppDescr::startElement (  const std::string &  uri, const std::string &  localName, const std::string &  qName, const qgxml::Attributes &  atts )  [virtual]

Todo: To be documented! Reimplemented from qgxml::DefaultHandler.

void qgar::QgarAppDescr::startParam (  const qgxml::Attributes &  atts  )  [protected]

Callback invoked when the parser starts parsing a new parameter section. For internal use only. The parameter sections are enclosed in a <ELT_PARAM> tag. Parameters: atts  The attributes of the <ELT_PARAM> element. See also: qgar::QgarAppDescr::endParam() Definition at line 504 of file QgarAppDescr.C. References _parseData, qgar::QgarAppDescr::ParseData::currentParam, qgxml::Attributes::getLength(), qgxml::Attributes::getLocalName(), qgxml::Attributes::getValue(), PARAM, qgar::QgarAppParamDescr::QGE_DXF, qgar::QgarAppParamDescr::QGE_IMAGE, qgar::QgarAppParamDescr::QGE_IN, qgar::QgarAppParamDescr::QGE_INOUT, qgar::QgarAppParamDescr::QGE_INT, qgar::QgarAppParamDescr::QGE_NUM, qgar::QgarAppParamDescr::QGE_OUT, qgar::QgarAppParamDescr::QGE_PBM, qgar::QgarAppParamDescr::QGE_PGM, qgar::QgarAppParamDescr::QGE_PPM, qgar::QgarAppParamDescr::QGE_REAL, qgar::QgarAppParamDescr::QGE_SVG, qgar::QgarAppParamDescr::QGE_UNKNOWN_FORMAT, and qgar::QgarAppDescr::ParseData::state.

virtual void qgxml::DefaultHandler::startPrefixMapping (  const std::string &  prefix, const std::string &  uri )  [inline, virtual, inherited]

Begin the scope of a prefix-URI Namespace mapping. Parameters: prefix  The Namespace prefix being declared. An empty string is used for the default element namespace, which has no prefix. uri  The Namespace URI the prefix is mapped to. See also: endPrefixMapping() Implements qgxml::ContentHandler. Definition at line 143 of file DefaultHandler.H.

string qgar::QgarAppDescr::toXml (   )  const

Builds an XML document representating this application description. Returns: Definition at line 209 of file QgarAppDescr.C.

virtual void qgxml::DefaultHandler::unparsedEntityDecl (  const std::string &  name, const std::string &  publicId, const std::string &  systemId, const std::string &  notationName )  [inline, virtual, inherited]

Receive notification of an unparsed entity declaration event. Parameters: name  The unparsed entity's name. publicId  The entity's public identifier. systemId  The entity's system identifier. notationName  The name of the associated notation. Implements qgxml::DTDHandler. Definition at line 160 of file DefaultHandler.H.

virtual void qgxml::DefaultHandler::warning (  const SAXParseException &  exception  )  [inline, virtual, inherited]

Receive notification of a warning. Parameters: exception  The warning information encapsulated in a SAX parse exception. Implements qgxml::ErrorHandler. Definition at line 190 of file DefaultHandler.H.

---

Member Data Documentation

std::string qgar::QgarAppDescr::_author [protected]

The author of the application. Definition at line 567 of file QgarAppDescr.H. Referenced by accessAuthor(), and author().

std::string qgar::QgarAppDescr::_briefDoc [protected]

The brief documentation. Definition at line 573 of file QgarAppDescr.H. Referenced by accessBriefDoc(), briefDoc(), and operator=().

std::string qgar::QgarAppDescr::_copyright [protected]

The copyright notice. Definition at line 570 of file QgarAppDescr.H. Referenced by accessCopyright(), copyright(), and operator=().

std::string qgar::QgarAppDescr::_longDoc [protected]

The documentation verbose version. Definition at line 576 of file QgarAppDescr.H. Referenced by accessLongDoc(), longDoc(), and operator=().

std::string qgar::QgarAppDescr::_name [protected]

The name of the application. Definition at line 564 of file QgarAppDescr.H. Referenced by accessName(), name(), and operator=().

std::vector<QgarAppParamDescr *> qgar::QgarAppDescr::_paramVect [protected]

The descriptions of the application parameters. Definition at line 579 of file QgarAppDescr.H. Referenced by accessParamVect(), addParamDescr(), operator=(), paramVect(), QgarAppDescr(), and ~QgarAppDescr().

const char *const qgar::QgarAppDescr::ATT_FLAG = "flag" [static]

Definition at line 86 of file QgarAppDescr.C.

const char *const qgar::QgarAppDescr::ATT_FORMAT = "format" [static]

Definition at line 89 of file QgarAppDescr.C.

const char *const qgar::QgarAppDescr::ATT_LANG = "lang" [static]

Definition at line 84 of file QgarAppDescr.C.

const char *const qgar::QgarAppDescr::ATT_NAME = "name" [static]

Definition at line 85 of file QgarAppDescr.C.

const char *const qgar::QgarAppDescr::ATT_PASSING_MODE = "passing-mode" [static]

Definition at line 88 of file QgarAppDescr.C.

const char *const qgar::QgarAppDescr::ATT_REQUIRED = "required" [static]

Definition at line 87 of file QgarAppDescr.C.

const char *const qgar::QgarAppDescr::ATT_REVISION = "revision" [static]

Definition at line 83 of file QgarAppDescr.C.

const char *const qgar::QgarAppDescr::ATT_TYPE = "type" [static]

Definition at line 90 of file QgarAppDescr.C.

const char *const qgar::QgarAppDescr::ELT_APPLICATION = "application" [static]

Definition at line 71 of file QgarAppDescr.C.

const char *const qgar::QgarAppDescr::ELT_AUTHOR = "author" [static]

Definition at line 77 of file QgarAppDescr.C.

const char *const qgar::QgarAppDescr::ELT_BRIEF = "brief" [static]

Definition at line 80 of file QgarAppDescr.C.

const char *const qgar::QgarAppDescr::ELT_COPYRIGHT = "copyright" [static]

Definition at line 78 of file QgarAppDescr.C.

const char *const qgar::QgarAppDescr::ELT_DESCR = "descr" [static]

Definition at line 72 of file QgarAppDescr.C.

const char *const qgar::QgarAppDescr::ELT_DOC = "doc" [static]

Definition at line 79 of file QgarAppDescr.C.

const char *const qgar::QgarAppDescr::ELT_DOCUMENTATION = "documentation" [static]

Definition at line 73 of file QgarAppDescr.C.

const char *const qgar::QgarAppDescr::ELT_LONG = "long" [static]

Definition at line 81 of file QgarAppDescr.C.

const char *const qgar::QgarAppDescr::ELT_NAME = "name" [static]

Definition at line 76 of file QgarAppDescr.C.

const char *const qgar::QgarAppDescr::ELT_PARAM = "param" [static]

Definition at line 75 of file QgarAppDescr.C.

const char *const qgar::QgarAppDescr::ELT_PARAMLIST = "paramlist" [static]

Definition at line 74 of file QgarAppDescr.C.

---

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

• QgarAppDescr.H
• QgarAppDescr.C