OSFI.UsageReader.UsageReader Class Reference

Public Member Functions
def	__init__ (self, xmlFile)
def	getUsage (self)

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

__init__()

def OSFI.UsageReader.UsageReader.__init__	(		self,
			xmlFile
	)

 Class constructor.
 @param xmlFile Location of the XML file with the usage description.
 @throws exception if an error occurred while parsing the file

References OSFI.UsageReader.UsageReader.__usage.

Member Function Documentation

getUsage()

def OSFI.UsageReader.UsageReader.getUsage

(

self

)

 Returns a string with the usage description.

References OSFI.UsageReader.UsageReader.__usage.

---

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

• include/Python/OSFI/UsageReader.py