MythTV  master
Public Member Functions | Protected Member Functions | List of all members
MythJobQueueCommandLineParser Class Reference

#include <mythjobqueue_commandlineparser.h>

Inheritance diagram for MythJobQueueCommandLineParser:
Inheritance graph
[legend]
Collaboration diagram for MythJobQueueCommandLineParser:
Collaboration graph
[legend]

Public Member Functions

 MythJobQueueCommandLineParser ()
 
void LoadArguments (void) override
 
- Public Member Functions inherited from MythCommandLineParser
 MythCommandLineParser (QString appname)
 Default constructor for MythCommandLineArg class. More...
 
virtual ~MythCommandLineParser ()
 
void PrintHelp (void) const
 Print command line option help. More...
 
QString GetHelpString (void) const
 Generate command line option help text. More...
 
virtual bool Parse (int argc, const char *const *argv)
 Loop through argv and populate arguments with values. More...
 
CommandLineArgadd (const QString &arg, const QString &name, bool def, QString help, QString longhelp)
 
CommandLineArgadd (const QString &arg, const QString &name, int def, QString help, QString longhelp)
 
CommandLineArgadd (const QString &arg, const QString &name, uint def, QString help, QString longhelp)
 
CommandLineArgadd (const QString &arg, const QString &name, long long def, QString help, QString longhelp)
 
CommandLineArgadd (const QString &arg, const QString &name, double def, QString help, QString longhelp)
 
CommandLineArgadd (const QString &arg, const QString &name, const char *def, QString help, QString longhelp)
 
CommandLineArgadd (const QString &arg, const QString &name, const QString &def, QString help, QString longhelp)
 
CommandLineArgadd (const QString &arg, const QString &name, QSize def, QString help, QString longhelp)
 
CommandLineArgadd (const QString &arg, const QString &name, const QDateTime &def, QString help, QString longhelp)
 
CommandLineArgadd (const QString &arg, const QString &name, QMetaType::Type type, QString help, QString longhelp)
 
CommandLineArgadd (const QString &arg, const QString &name, QMetaType::Type type, QVariant def, QString help, QString longhelp)
 
CommandLineArgadd (QStringList arglist, const QString &name, bool def, QString help, QString longhelp)
 
CommandLineArgadd (QStringList arglist, const QString &name, int def, QString help, QString longhelp)
 
CommandLineArgadd (QStringList arglist, const QString &name, uint def, QString help, QString longhelp)
 
CommandLineArgadd (QStringList arglist, const QString &name, long long def, QString help, QString longhelp)
 
CommandLineArgadd (QStringList arglist, const QString &name, double def, QString help, QString longhelp)
 
CommandLineArgadd (QStringList arglist, const QString &name, const char *def, QString help, QString longhelp)
 
CommandLineArgadd (QStringList arglist, const QString &name, const QString &def, QString help, QString longhelp)
 
CommandLineArgadd (QStringList arglist, const QString &name, QSize def, QString help, QString longhelp)
 
CommandLineArgadd (QStringList arglist, const QString &name, const QDateTime &def, QString help, QString longhelp)
 
CommandLineArgadd (QStringList arglist, const QString &name, QMetaType::Type type, QString help, QString longhelp)
 
CommandLineArgadd (QStringList arglist, const QString &name, QMetaType::Type type, QVariant def, QString help, QString longhelp)
 Add a new command line argument. More...
 
QVariant operator[] (const QString &name)
 Returned stored QVariant for given argument, or default value if not used. More...
 
QStringList GetArgs (void) const
 Return list of additional values provided on the command line independent of any keyword. More...
 
QMap< QString, QString > GetExtra (void) const
 Return map of additional key/value pairs provided on the command line independent of any registered argument. More...
 
QString GetPassthrough (void) const
 Return any text supplied on the command line after a bare '–'. More...
 
QMap< QString, QString > GetSettingsOverride (void)
 Return map of key/value pairs provided to override database options. More...
 
QString GetLogFilePath (void)
 Helper utility for logging interface to pull path from –logpath. More...
 
int GetSyslogFacility (void) const
 Helper utility for logging interface to return syslog facility. More...
 
LogLevel_t GetLogLevel (void) const
 Helper utility for logging interface to filtering level. More...
 
QString GetAppName (void) const
 
bool toBool (const QString &key) const
 Returns stored QVariant as a boolean. More...
 
int toInt (const QString &key) const
 Returns stored QVariant as an integer, falling to default if not provided. More...
 
uint toUInt (const QString &key) const
 Returns stored QVariant as an unsigned integer, falling to default if not provided. More...
 
long long toLongLong (const QString &key) const
 Returns stored QVariant as a long integer, falling to default if not provided. More...
 
double toDouble (const QString &key) const
 Returns stored QVariant as double floating point value, falling to default if not provided. More...
 
QSize toSize (const QString &key) const
 Returns stored QVariant as a QSize value, falling to default if not provided. More...
 
QString toString (const QString &key) const
 Returns stored QVariant as a QString, falling to default if not provided. More...
 
QStringList toStringList (const QString &key, const QString &sep="") const
 Returns stored QVariant as a QStringList, falling to default if not provided. More...
 
QMap< QString, QString > toMap (const QString &key) const
 Returns stored QVariant as a QMap, falling to default if not provided. More...
 
QDateTime toDateTime (const QString &key) const
 Returns stored QVariant as a QDateTime, falling to default if not provided. More...
 
bool SetValue (const QString &key, const QVariant &value)
 Set a new stored value for an existing argument definition, or spawn a new definition store value in. More...
 
int ConfigureLogging (const QString &mask="general", bool progress=false)
 Read in logging options and initialize the logging interface. More...
 
void ApplySettingsOverride (void)
 Apply all overrides to the global context. More...
 
int Daemonize (void) const
 Fork application into background, and detatch from terminal. More...
 

Protected Member Functions

QString GetHelpHeader (void) const override
 
- Protected Member Functions inherited from MythCommandLineParser
void allowArgs (bool allow=true)
 Specify that parser should allow and collect values provided independent of any keyword. More...
 
void allowExtras (bool allow=true)
 Specify that parser should allow and collect additional key/value pairs not explicitly defined for processing. More...
 
void allowPassthrough (bool allow=true)
 Specify that parser should allow a bare '–', and collect all subsequent text as a QString. More...
 
void addHelp (void)
 Canned argument definition for –help. More...
 
void addVersion (void)
 Canned argument definition for –version. More...
 
void addWindowed (void)
 Canned argument definition for –windowed and -no-windowed. More...
 
void addMouse (void)
 Canned argument definition for –mouse-cursor and –no-mouse-cursor. More...
 
void addDaemon (void)
 Canned argument definition for –daemon. More...
 
void addSettingsOverride (void)
 Canned argument definition for –override-setting and –override-settings-file. More...
 
void addRecording (void)
 Canned argument definition for –chanid and –starttime. More...
 
void addGeometry (void)
 Canned argument definition for –geometry. More...
 
void addDisplay (void)
 Canned argument definition for -display. More...
 
void addUPnP (void)
 Canned argument definition for –noupnp. More...
 
void addDVBv3 (void)
 Canned argument definition for –dvbv3. More...
 
void addLogging (const QString &defaultVerbosity="general", LogLevel_t defaultLogLevel=LOG_INFO)
 Canned argument definition for all logging options, including –verbose, –logpath, –quiet, –loglevel, –syslog. More...
 
void addPIDFile (void)
 Canned argument definition for –pidfile. More...
 
void addJob (void)
 Canned argument definition for –jobid. More...
 
void addInFile (bool addOutFile=false)
 Canned argument definition for –infile and –outfile. More...
 
void addPlatform (void)
 Pass through the platform argument to Qt for GUI applications. More...
 

Additional Inherited Members

- Public Types inherited from MythCommandLineParser
enum  Result {
  Result::kEnd = 0, Result::kEmpty = 1, Result::kOptOnly = 2, Result::kOptVal = 3,
  Result::kCombOptVal = 4, Result::kArg = 5, Result::kPassthrough = 6, Result::kInvalid = 7
}
 
- Static Public Member Functions inherited from MythCommandLineParser
static QStringList MythSplitCommandString (const QString &line)
 Parse a string into separate tokens. More...
 
static void PrintVersion (void)
 Print application version information. More...
 
static const char * NamedOptType (Result type)
 
- Public Attributes inherited from MythCommandLineParser
friend TestCommandLineParser
 

Detailed Description

Definition at line 6 of file mythjobqueue_commandlineparser.h.

Constructor & Destructor Documentation

◆ MythJobQueueCommandLineParser()

MythJobQueueCommandLineParser::MythJobQueueCommandLineParser ( )

Definition at line 6 of file mythjobqueue_commandlineparser.cpp.

Member Function Documentation

◆ LoadArguments()

void MythJobQueueCommandLineParser::LoadArguments ( void  )
overridevirtual

Reimplemented from MythCommandLineParser.

Definition at line 16 of file mythjobqueue_commandlineparser.cpp.

Referenced by MythJobQueueCommandLineParser().

◆ GetHelpHeader()

QString MythJobQueueCommandLineParser::GetHelpHeader ( void  ) const
overrideprotectedvirtual

Reimplemented from MythCommandLineParser.

Definition at line 10 of file mythjobqueue_commandlineparser.cpp.


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