Search Toolkit Book for CPrimeNumbersJob

#include <gui/wx_demo/test_client.hpp>

Inheritance diagram for CPrimeNumbersJob:

Collaboration diagram for CPrimeNumbersJob:

Classes
class	CResult

Public Member Functions
	CPrimeNumbersJob (int max)
	CPrimeNumbersJob. More...

	CPrimeNumbersJob (int max)

IAppJob implementation
virtual IAppJob::EJobState	Run ()
	Function that does all the useful work, called by the Engine. More...

virtual CConstIRef< IAppJobProgress >	GetProgress ()
	return progress object, the function shall be synchronized internally. More...

virtual CRef< CObject >	GetResult ()
	Returns the Job Result. More...

virtual CConstIRef< IAppJobError >	GetError ()
	Returns IAppJobError object describing internal error that caused the Job to fail. More...

virtual string	GetDescr () const
	Returns a human readable description of the Job (optional) More...

virtual void	RequestCancel ()
	RequestCancel() is called to notify the Job that it shall exit Run() function ASAP. More...

virtual bool	IsCanceled () const

virtual IAppJob::EJobState	Run ()
	Function that does all the useful work, called by the Engine. More...

virtual void	RequestCancel ()
	RequestCancel() is called to notify the Job that it shall exit Run() function ASAP. More...

virtual CConstIRef< IAppJobProgress >	GetProgress ()
	return progress object, the function shall be synchronized internally. More...

virtual CRef< CObject >	GetResult ()
	Returns the Job Result. More...

virtual CConstIRef< IAppJobError >	GetError ()
	Returns IAppJobError object describing internal error that caused the Job to fail. More...

virtual string	GetDescr () const
	Returns a human readable description of the Job (optional) More...

Public Member Functions inherited from CObject
	CObject (void)
	Constructor. More...

	CObject (const CObject &src)
	Copy constructor. More...

virtual	~CObject (void)
	Destructor. More...

CObject &	operator= (const CObject &src) THROWS_NONE
	Assignment operator. More...

bool	CanBeDeleted (void) const THROWS_NONE
	Check if object can be deleted. More...

bool	IsAllocatedInPool (void) const THROWS_NONE
	Check if object is allocated in memory pool (not system heap) More...

bool	Referenced (void) const THROWS_NONE
	Check if object is referenced. More...

bool	ReferencedOnlyOnce (void) const THROWS_NONE
	Check if object is referenced only once. More...

void	AddReference (void) const
	Add reference to object. More...

void	RemoveReference (void) const
	Remove reference to object. More...

void	ReleaseReference (void) const
	Remove reference without deleting object. More...

virtual void	DoNotDeleteThisObject (void)
	Mark this object as not allocated in heap – do not delete this object. More...

virtual void	DoDeleteThisObject (void)
	Mark this object as allocated in heap – object can be deleted. More...

void *	operator new (size_t size)
	Define new operator for memory allocation. More...

void *	operator new[] (size_t size)
	Define new[] operator for 'array' memory allocation. More...

void	operator delete (void *ptr)
	Define delete operator for memory deallocation. More...

void	operator delete[] (void *ptr)
	Define delete[] operator for memory deallocation. More...

void *	operator new (size_t size, void *place)
	Define new operator. More...

void	operator delete (void ptr, void place)
	Define delete operator. More...

void *	operator new (size_t size, CObjectMemoryPool *place)
	Define new operator using memory pool. More...

void	operator delete (void ptr, CObjectMemoryPool place)
	Define delete operator. More...

virtual void	DebugDump (CDebugDumpContext ddc, unsigned int depth) const
	Define method for dumping debug information. More...

Public Member Functions inherited from CDebugDumpable
	CDebugDumpable (void)

virtual	~CDebugDumpable (void)

void	DebugDumpText (ostream &out, const string &bundle, unsigned int depth) const

void	DebugDumpFormat (CDebugDumpFormatter &ddf, const string &bundle, unsigned int depth) const

void	DumpToConsole (void) const

Public Member Functions inherited from IAppJob
virtual	~IAppJob ()

virtual bool	BeforeRun ()
	Function will be called on the main thread before execution of Run Should not do any lengthy work returns true to continue job execution on worker thread false to quit execution with status - failed. More...

Protected Attributes
int	m_MaxNumber

bool	m_StopRequested

bool	m_Finished

CConstIRef< IAppJobProgress >	m_Progress

CRef< CResult >	m_Result

CConstIRef< IAppJobError >	m_Error

Additional Inherited Members
Public Types inherited from CObject
enum	EAllocFillMode { eAllocFillNone = 1 , eAllocFillZero , eAllocFillPattern }
	Control filling of newly allocated memory. More...

typedef CObjectCounterLocker	TLockerType
	Default locker type for CRef. More...

typedef atomic< Uint8 >	TCounter
	Counter type is CAtomiCounter. More...

typedef Uint8	TCount
	Alias for value type of counter. More...

Public Types inherited from IAppJob
enum	EJobState { eInvalid , eRunning , eCompleted , eFailed , eCanceled , eSuspended }
	Job states (describe FSM) More...

Static Public Member Functions inherited from CObject
static NCBI_XNCBI_EXPORT void	ThrowNullPointerException (void)
	Define method to throw null pointer exception. More...

static NCBI_XNCBI_EXPORT void	ThrowNullPointerException (const type_info &type)

static EAllocFillMode	GetAllocFillMode (void)

static void	SetAllocFillMode (EAllocFillMode mode)

static void	SetAllocFillMode (const string &value)
	Set mode from configuration parameter value. More...

Static Public Member Functions inherited from CDebugDumpable
static void	EnableDebugDump (bool on)

Static Public Attributes inherited from CObject
static const TCount	eCounterBitsCanBeDeleted = 1 << 0
	Define possible object states. More...

static const TCount	eCounterBitsInPlainHeap = 1 << 1
	Heap signature was found. More...

static const TCount	eCounterBitsPlaceMask
	Mask for 'in heap' state flags. More...

static const int	eCounterStep = 1 << 2
	Skip over the "in heap" bits. More...

static const TCount	eCounterValid = TCount(1) << (sizeof(TCount) * 8 - 2)
	Minimal value for valid objects (reference counter is zero) Must be a single bit value. More...

static const TCount	eCounterStateMask
	Valid object, and object in heap. More...

Protected Member Functions inherited from CObject
virtual void	DeleteThis (void)
	Virtual method "deleting" this object. More...

Detailed Description

CPrimeNumbersJob.

Definition at line 43 of file test_client.hpp.

Constructor & Destructor Documentation

◆ CPrimeNumbersJob() [1/2]

CPrimeNumbersJob::CPrimeNumbersJob ( int max )

CPrimeNumbersJob.

Definition at line 44 of file test_client.cpp.

◆ CPrimeNumbersJob() [2/2]

CPrimeNumbersJob::CPrimeNumbersJob ( int max )

Member Function Documentation

◆ GetDescr() [1/2]

string CPrimeNumbersJob::GetDescr ( ) const

virtual

Returns a human readable description of the Job (optional)

Implements IAppJob.

Definition at line 123 of file test_client.cpp.

References NStr::IntToString(), and m_MaxNumber.

◆ GetDescr() [2/2]

virtual string CPrimeNumbersJob::GetDescr ( ) const

virtual

Returns a human readable description of the Job (optional)

Implements IAppJob.

◆ GetError() [1/2]

CConstIRef< IAppJobError > CPrimeNumbersJob::GetError ( )

virtual

Returns IAppJobError object describing internal error that caused the Job to fail.

Result shall be returned only if the Job did fail.

Implements IAppJob.

Definition at line 117 of file test_client.cpp.

References m_Error.

◆ GetError() [2/2]

virtual CConstIRef<IAppJobError> CPrimeNumbersJob::GetError ( )

virtual

Returns IAppJobError object describing internal error that caused the Job to fail.

Result shall be returned only if the Job did fail.

Implements IAppJob.

◆ GetProgress() [1/2]

CConstIRef< IAppJobProgress > CPrimeNumbersJob::GetProgress ( )

virtual

return progress object, the function shall be synchronized internally.

the returned object should not be modified by the job (job shall create a new instance of Progress object on every GetProgress() invocation).

Implements IAppJob.

Definition at line 104 of file test_client.cpp.

References m_Progress.

◆ GetProgress() [2/2]

virtual CConstIRef<IAppJobProgress> CPrimeNumbersJob::GetProgress ( )

virtual

return progress object, the function shall be synchronized internally.

the returned object should not be modified by the job (job shall create a new instance of Progress object on every GetProgress() invocation).

Implements IAppJob.

◆ GetResult() [1/2]

CRef< CObject > CPrimeNumbersJob::GetResult ( )

virtual

Returns the Job Result.

Derive your own object from CObject and return it from your Job class. Result shall be returned only if Job finished succesfully.

Implements IAppJob.

Definition at line 110 of file test_client.cpp.

References m_Finished, m_Result, and NULL.

◆ GetResult() [2/2]

virtual CRef<CObject> CPrimeNumbersJob::GetResult ( )

virtual

Returns the Job Result.

Derive your own object from CObject and return it from your Job class. Result shall be returned only if Job finished succesfully.

Implements IAppJob.

◆ IsCanceled()

virtual bool CPrimeNumbersJob::IsCanceled ( void ) const

inlinevirtual

Implements IAppJob.

Definition at line 62 of file test_client.hpp.

References m_StopRequested.

◆ RequestCancel() [1/2]

void CPrimeNumbersJob::RequestCancel ( )

virtual

RequestCancel() is called to notify the Job that it shall exit Run() function ASAP.

The function shall be synchronized internally.

Implements IAppJob.

Definition at line 98 of file test_client.cpp.

References m_StopRequested.

◆ RequestCancel() [2/2]

virtual void CPrimeNumbersJob::RequestCancel ( )

virtual

RequestCancel() is called to notify the Job that it shall exit Run() function ASAP.

The function shall be synchronized internally.

Implements IAppJob.

◆ Run() [1/2]

IAppJob::EJobState CPrimeNumbersJob::Run ( )

virtual

Function that does all the useful work, called by the Engine.

Run() shall be implemented so that it will allow for exiting once RequestCancel() is called.

Implements IAppJob.

Definition at line 52 of file test_client.cpp.

References IAppJob::eCanceled, IAppJob::eCompleted, IAppJob::eFailed, i, NStr::Int8ToString(), NStr::IntToString(), LOG_POST, m_Error, m_Finished, m_MaxNumber, m_Progress, m_Result, m_StopRequested, prime(), CConstRef< C, Locker >::Reset(), and SleepMilliSec().

◆ Run() [2/2]

virtual IAppJob::EJobState CPrimeNumbersJob::Run ( )

virtual

Function that does all the useful work, called by the Engine.

Run() shall be implemented so that it will allow for exiting once RequestCancel() is called.

Implements IAppJob.

Member Data Documentation

◆ m_Error

CConstIRef< IAppJobError > CPrimeNumbersJob::m_Error

protected

Definition at line 72 of file test_client.hpp.

Referenced by GetError(), and Run().

◆ m_Finished

bool CPrimeNumbersJob::m_Finished

protected

Definition at line 68 of file test_client.hpp.

Referenced by GetResult(), and Run().

◆ m_MaxNumber

int CPrimeNumbersJob::m_MaxNumber

protected

Definition at line 66 of file test_client.hpp.

Referenced by GetDescr(), and Run().

◆ m_Progress

CConstIRef< IAppJobProgress > CPrimeNumbersJob::m_Progress

protected

Definition at line 70 of file test_client.hpp.

Referenced by GetProgress(), and Run().

◆ m_Result

CRef< CResult > CPrimeNumbersJob::m_Result

protected

Definition at line 71 of file test_client.hpp.

Referenced by GetResult(), and Run().

◆ m_StopRequested

bool CPrimeNumbersJob::m_StopRequested

protected

Definition at line 67 of file test_client.hpp.

Referenced by IsCanceled(), RequestCancel(), and Run().

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

include/gui/wx_demo/test_client.hpp
src/gui/utils/app_job/test_client.cpp

Classes

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ CPrimeNumbersJob() [1/2]

◆ CPrimeNumbersJob() [2/2]

Member Function Documentation

◆ GetDescr() [1/2]

◆ GetDescr() [2/2]

◆ GetError() [1/2]

◆ GetError() [2/2]

◆ GetProgress() [1/2]

◆ GetProgress() [2/2]

◆ GetResult() [1/2]

◆ GetResult() [2/2]

◆ IsCanceled()

◆ RequestCancel() [1/2]

◆ RequestCancel() [2/2]

◆ Run() [1/2]

◆ Run() [2/2]

Member Data Documentation

◆ m_Error

◆ m_Finished

◆ m_MaxNumber

◆ m_Progress

◆ m_Result

◆ m_StopRequested