MythTV  master
Public Types | Signals | Public Member Functions | Private Member Functions | Private Attributes | List of all members
GrabberScript Class Reference

#include <netgrabbermanager.h>

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

Public Types

typedef QList< GrabberScript * > scriptList
 

Signals

void finished (void)
 

Public Member Functions

 GrabberScript (const QString &title, const QString &image, const ArticleType &type, const QString &author, const bool &search, const bool &tree, const QString &description, const QString &commandline, const double &version)
 
 ~GrabberScript ()
 
const QString & GetTitle () const
 
const QString & GetImage () const
 
const ArticleTypeGetType () const
 
const QString & GetAuthor () const
 
const boolGetSearch () const
 
const boolGetTree () const
 
const QString & GetDescription () const
 
const QString & GetCommandline () const
 
const double & GetVersion () const
 
void run (void) override
 Runs the Qt event loop unless we have a QRunnable, in which case we run the runnable run instead. More...
 
- Public Member Functions inherited from MThread
 MThread (const QString &objectName)
 Standard constructor. More...
 
 MThread (const QString &objectName, QRunnable *runnable)
 Use this constructor if you want the default run() method to run the QRunnable's run() method instead of entering the Qt event loop. More...
 
virtual ~MThread ()
 
void RunProlog (void)
 Sets up a thread, call this if you reimplement run(). More...
 
void RunEpilog (void)
 Cleans up a thread's resources, call this if you reimplement run(). More...
 
QThread * qthread (void)
 Returns the thread, this will always return the same pointer no matter how often you restart the thread. More...
 
void setObjectName (const QString &name)
 
QString objectName (void) const
 
void setPriority (QThread::Priority priority)
 
QThread::Priority priority (void) const
 
bool isFinished (void) const
 
bool isRunning (void) const
 
void setStackSize (uint stackSize)
 
uint stackSize (void) const
 
void exit (int retcode=0)
 Use this to exit from the thread if you are using a Qt event loop. More...
 
void start (QThread::Priority=QThread::InheritPriority)
 Tell MThread to start running the thread in the near future. More...
 
void terminate (void)
 Kill a thread unsafely. More...
 
void quit (void)
 calls exit(0) More...
 
bool wait (unsigned long time=ULONG_MAX)
 Wait for the MThread to exit, with a maximum timeout. More...
 

Private Member Functions

void parseDBTree (const QString &feedtitle, const QString &path, const QString &pathThumb, QDomElement &domElem, const ArticleType &type)
 

Private Attributes

QMutex m_lock {QMutex::Recursive}
 
QString m_title
 
QString m_image
 
ArticleType m_type
 
QString m_author
 
bool m_search
 
bool m_tree
 
QString m_description
 
QString m_commandline
 
double m_version
 

Additional Inherited Members

- Static Public Member Functions inherited from MThread
static void ThreadSetup (const QString &)
 This is to be called on startup in those few threads that haven't been ported to MThread. More...
 
static void ThreadCleanup (void)
 This is to be called on exit in those few threads that haven't been ported to MThread. More...
 
static void Cleanup (void)
 This will print out all the running threads, call exit(1) on each and then wait up to 5 seconds total for all the threads to exit. More...
 
static void GetAllThreadNames (QStringList &list)
 
static void GetAllRunningThreadNames (QStringList &list)
 
- Static Public Attributes inherited from MThread
static const int kDefaultStartTimeout
 
- Protected Member Functions inherited from MThread
int exec (void)
 Enters the qt event loop. call exit or quit to exit thread. More...
 
- Static Protected Member Functions inherited from MThread
static void setTerminationEnabled (bool enabled=true)
 
static void sleep (unsigned long time)
 
static void msleep (unsigned long time)
 
static void usleep (unsigned long time)
 
- Protected Attributes inherited from MThread
MThreadInternalm_thread {nullptr}
 
QRunnable * m_runnable {nullptr}
 
bool m_prolog_executed {true}
 
bool m_epilog_executed {true}
 

Detailed Description

Definition at line 16 of file netgrabbermanager.h.

Member Typedef Documentation

◆ scriptList

Definition at line 46 of file netgrabbermanager.h.

Constructor & Destructor Documentation

◆ GrabberScript()

GrabberScript::GrabberScript ( const QString &  title,
const QString &  image,
const ArticleType type,
const QString &  author,
const bool search,
const bool tree,
const QString &  description,
const QString &  commandline,
const double &  version 
)

Definition at line 25 of file netgrabbermanager.cpp.

◆ ~GrabberScript()

GrabberScript::~GrabberScript ( )

Definition at line 43 of file netgrabbermanager.cpp.

Member Function Documentation

◆ GetTitle()

const QString& GrabberScript::GetTitle ( ) const
inline

◆ GetImage()

const QString& GrabberScript::GetImage ( ) const
inline

Definition at line 35 of file netgrabbermanager.h.

Referenced by insertSearchInDB(), and insertTreeInDB().

◆ GetType()

const ArticleType& GrabberScript::GetType ( ) const
inline

Definition at line 36 of file netgrabbermanager.h.

Referenced by run().

◆ GetAuthor()

const QString& GrabberScript::GetAuthor ( ) const
inline

Definition at line 37 of file netgrabbermanager.h.

Referenced by insertSearchInDB(), and insertTreeInDB().

◆ GetSearch()

const bool& GrabberScript::GetSearch ( ) const
inline

Definition at line 38 of file netgrabbermanager.h.

◆ GetTree()

const bool& GrabberScript::GetTree ( ) const
inline

Definition at line 39 of file netgrabbermanager.h.

◆ GetDescription()

const QString& GrabberScript::GetDescription ( ) const
inline

Definition at line 40 of file netgrabbermanager.h.

Referenced by insertSearchInDB(), and insertTreeInDB().

◆ GetCommandline()

const QString& GrabberScript::GetCommandline ( ) const
inline

◆ GetVersion()

const double& GrabberScript::GetVersion ( ) const
inline

Definition at line 42 of file netgrabbermanager.h.

Referenced by insertSearchInDB(), and insertTreeInDB().

◆ run()

void GrabberScript::run ( void  )
overridevirtual

Runs the Qt event loop unless we have a QRunnable, in which case we run the runnable run instead.

Note
If you override this method you must call RunProlog before you do any work and RunEpilog before you exit the run method.

Reimplemented from MThread.

Definition at line 48 of file netgrabbermanager.cpp.

Referenced by GrabberDownloadThread::run().

◆ finished

void GrabberScript::finished ( void  )
signal

◆ parseDBTree()

void GrabberScript::parseDBTree ( const QString &  feedtitle,
const QString &  path,
const QString &  pathThumb,
QDomElement &  domElem,
const ArticleType type 
)
private

Definition at line 97 of file netgrabbermanager.cpp.

Referenced by run().

Member Data Documentation

◆ m_lock

QMutex GrabberScript::m_lock {QMutex::Recursive}
mutableprivate

Definition at line 57 of file netgrabbermanager.h.

Referenced by parseDBTree(), and run().

◆ m_title

QString GrabberScript::m_title
private

Definition at line 59 of file netgrabbermanager.h.

Referenced by GrabberScript(), and run().

◆ m_image

QString GrabberScript::m_image
private

Definition at line 60 of file netgrabbermanager.h.

Referenced by GrabberScript().

◆ m_type

ArticleType GrabberScript::m_type
private

Definition at line 61 of file netgrabbermanager.h.

Referenced by GrabberScript().

◆ m_author

QString GrabberScript::m_author
private

Definition at line 62 of file netgrabbermanager.h.

Referenced by GrabberScript().

◆ m_search

bool GrabberScript::m_search
private

Definition at line 63 of file netgrabbermanager.h.

Referenced by GrabberScript().

◆ m_tree

bool GrabberScript::m_tree
private

Definition at line 64 of file netgrabbermanager.h.

Referenced by GrabberScript().

◆ m_description

QString GrabberScript::m_description
private

Definition at line 65 of file netgrabbermanager.h.

Referenced by GrabberScript().

◆ m_commandline

QString GrabberScript::m_commandline
private

Definition at line 66 of file netgrabbermanager.h.

Referenced by GrabberScript(), and run().

◆ m_version

double GrabberScript::m_version
private

Definition at line 67 of file netgrabbermanager.h.

Referenced by GrabberScript().


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