UsageReader Class Reference

#include <UsageReader.h>

Public Member Functions
	UsageReader (const std::string &xmlFile)
const std::string &	getUsage () const

Detailed Description

This class is responsible to read a XML file showing the usage instructions of a certain executable in case the Command Line Arguments Parser (CLP) detects a failure in the executable invocation.

Constructor & Destructor Documentation

UsageReader()

UsageReader::UsageReader

(

const std::string &

xmlFile

)

Class constructor.

Parameters

xmlFile

Path to the XML file with the usage description.

Exceptions

exception

if an error occured while parsing the file

Member Function Documentation

getUsage()

const std::string& UsageReader::getUsage ( ) const

inline

Returns a string with the usage description.

---

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

• include/cpp/CLP/UsageReader.h