MythTV  master
Classes
Command Line Processing

Utility responsible for processing arguments from the command line. More...

Collaboration diagram for Command Line Processing:

Classes

class  CommandLineArg
 Definition for a single command line option. More...
 
class  MythCommandLineParser
 Parent class for defining application command line parsers. More...
 

Detailed Description

Utility responsible for processing arguments from the command line.

This fundamental design for this utility is a class that can be modularly configured with different optional arguments and behaviors, let process the received input arguments, and then persist for the results to be read out as needed.

In typical use, one will subclass MythCommandLineParser() and overwrite the LoadArguments() and GetHelpHeader() virtual functions. LoadArguments() is a convenient place to define default behaviors and accepted arguments. GetHelpHeader() is called for text describing the application, used when calling the '–help' argument. This utility will automatically handle help output, as well as check relationships between arguments.