CVideoLibraryScanningJob Class Reference

Video library job implementation for scanning items. More...

#include <VideoLibraryScanningJob.h>

Inheritance diagram for CVideoLibraryScanningJob:

Public Member Functions
	CVideoLibraryScanningJob (const std::string &directory, bool scanAll=false, bool showProgress=true)
	Creates a new video library scanning job.
	~CVideoLibraryScanningJob () override
bool	CanBeCancelled () const override
	Whether the job can be cancelled or not.
bool	Cancel () override
	Tries to cancel the running job.
const char *	GetType () const override
	Function that returns the type of job.
bool	Equals (const CJob *job) const override
	Function that compares this job instance with the given job instance.
Public Member Functions inherited from CVideoLibraryJob
	~CVideoLibraryJob () override
bool	DoWork () override
	Main workhorse function of CJob instances.
Public Member Functions inherited from CJob
	CJob ()=default
virtual	~CJob ()=default
	Destructor for job objects.
void	SetProgressCallback (CJobManager *callback)
	Function to set a callback for jobs to report progress.
virtual bool	ShouldCancel (unsigned int progress, unsigned int total) const
	Function for longer jobs to report progress and check whether they have been cancelled.

Protected Member Functions
bool	Work (CVideoDatabase &db) override
	Worker method to be implemented by an actual implementation.
Protected Member Functions inherited from CVideoLibraryJob
	CVideoLibraryJob ()

Additional Inherited Members
Public Types inherited from CJob
enum	PRIORITY {   PRIORITY_LOW_PAUSABLE = 0 , PRIORITY_LOW , PRIORITY_NORMAL , PRIORITY_HIGH ,   PRIORITY_DEDICATED }
	Priority levels for jobs, specified by clients when adding jobs to the CJobManager. More...

Detailed Description

Video library job implementation for scanning items.

Uses CVideoInfoScanner for the whole filesystem scanning and can be run with or without a visible progress bar.

Constructor & Destructor Documentation

CVideoLibraryScanningJob()

CVideoLibraryScanningJob::CVideoLibraryScanningJob	(	const std::string &	directory,
		bool	scanAll = false,
		bool	showProgress = true )

Creates a new video library scanning job.

Parameters

[in]	directory	Directory to be scanned for new items
[in]	scanAll	Whether to scan all items or not
[in]	showProgress	Whether to show a progress bar or not

~CVideoLibraryScanningJob()

CVideoLibraryScanningJob::~CVideoLibraryScanningJob ( )

overridedefault

Member Function Documentation

CanBeCancelled()

bool CVideoLibraryScanningJob::CanBeCancelled ( ) const

inlineoverridevirtual

Whether the job can be cancelled or not.

Reimplemented from CVideoLibraryJob.

Cancel()

bool CVideoLibraryScanningJob::Cancel ( )

overridevirtual

Tries to cancel the running job.

Returns

True if the job was cancelled, false otherwise

Reimplemented from CVideoLibraryJob.

Equals()

bool CVideoLibraryScanningJob::Equals ( const CJob * job ) const

overridevirtual

Function that compares this job instance with the given job instance.

CJob subclasses may optionally implement this to provide customized comparison functionality. This is useful for the CJobManager::AddJob() routine, which preempts similar jobs with the new job.

Parameters

job	the job to compared with this CJob instance.

Returns

if true, the two jobs are equal.

See also

CJobManager::AddJob()

Reimplemented from CJob.

GetType()

const char * CVideoLibraryScanningJob::GetType ( ) const

inlineoverridevirtual

Function that returns the type of job.

CJob subclasses may optionally implement this function to specify the type of job. This is useful for the CJobManager::AddJob() routine, which preempts similar jobs with the new job.

Returns

a unique character string describing the job.

See also

CJobManager

Reimplemented from CVideoLibraryJob.

Work()

bool CVideoLibraryScanningJob::Work ( CVideoDatabase & db )

overrideprotectedvirtual

Worker method to be implemented by an actual implementation.

Parameters

[in]

db

Already open video database to be used for interaction

Returns

True if the process succeeded, false otherwise

Implements CVideoLibraryJob.

---

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

• VideoLibraryScanningJob.h
• VideoLibraryScanningJob.cpp