#include <Modules.h>

Inheritance diagram for CFPTimer:

Collaboration diagram for CFPTimer:

Public Member Functions
	CFPTimer (CModule *pModule, unsigned int uInterval, unsigned int uCycles, const CString &sLabel, const CString &sDescription)

virtual	~CFPTimer ()

void	SetFPCallback (FPTimer_t p)

void	SetModule (CModule *p)

void	SetDescription (const CString &s)

CModule *	GetModule () const

const CString &	GetDescription () const

void	run (timeval &tNow)
	This is used by the Job Manager, and not you directly. More...

void	StartMaxCycles (double dTimeSequence, uint32_t iMaxCycles)

void	StartMaxCycles (const timeval &tTimeSequence, uint32_t iMaxCycles)

void	Start (double dTimeSequence)
	starts and runs infinity amount of times More...

void	Start (const timeval &TimeSequence)

void	Stop ()
	call this to turn off your cron, it will be removed More...

void	Pause ()
	pauses excution of your code in RunJob More...

void	UnPause ()
	removes the pause on RunJon More...

void	Reset ()
	reset the timer More...

timeval	GetInterval () const

uint32_t	GetMaxCycles () const

uint32_t	GetCyclesLeft () const

bool	isValid () const
	returns true if cron is active More...

const CS_STRING &	GetName () const

void	SetName (const CS_STRING &sName)

timeval	GetNextRun () const
	returns the timestamp of the next estimated run time. Note that it may not run at this EXACT time, but it will run at least at this time or after More...

Protected Member Functions
void	RunJob () override
	this is the method you should override More...

Protected Attributes
CModule *	m_pModule

CString	m_sDescription

bool	m_bRunOnNextCall
	if set to true, RunJob() gets called on next invocation of run() despite the timeout More...

Constructor & Destructor Documentation

CFPTimer::CFPTimer	(	CModule *	pModule,
		unsigned int	uInterval,
		unsigned int	uCycles,
		const CString &	sLabel,
		const CString &	sDescription
	)

inline

virtual CFPTimer::~CFPTimer ( )

inlinevirtual

Member Function Documentation

uint32_t CCron::GetCyclesLeft ( ) const

inherited

const CString& CTimer::GetDescription ( ) const

inherited

timeval CCron::GetInterval ( ) const

inherited

uint32_t CCron::GetMaxCycles ( ) const

inherited

CModule* CTimer::GetModule ( ) const

inherited

const CS_STRING& CCron::GetName ( ) const

inherited

timeval CCron::GetNextRun ( ) const

inlineinherited

returns the timestamp of the next estimated run time. Note that it may not run at this EXACT time, but it will run at least at this time or after

bool CCron::isValid ( ) const

inherited

returns true if cron is active

void CCron::Pause ( )

inherited

pauses excution of your code in RunJob

void CCron::Reset ( )

inherited

reset the timer

void CCron::run ( timeval & tNow )

inherited

This is used by the Job Manager, and not you directly.

void CFPTimer::RunJob ( )

inlineoverrideprotectedvirtual

this is the method you should override

Reimplemented from CCron.

void CTimer::SetDescription ( const CString & s )

inherited

void CFPTimer::SetFPCallback ( FPTimer_t p )

inline

void CTimer::SetModule ( CModule * p )

inherited

void CCron::SetName ( const CS_STRING & sName )

inherited

void CCron::Start ( double dTimeSequence )

inherited

starts and runs infinity amount of times

void CCron::Start ( const timeval & TimeSequence )

inherited

void CCron::StartMaxCycles	(	double	dTimeSequence,
		uint32_t	iMaxCycles
	)

inherited

Parameters

TimeSequence	how often to run in seconds
iMaxCycles	how many times to run, 0 makes it run forever

void CCron::StartMaxCycles	(	const timeval &	tTimeSequence,
		uint32_t	iMaxCycles
	)

inherited

void CCron::Stop ( )

inherited

call this to turn off your cron, it will be removed

void CCron::UnPause ( )

inherited

removes the pause on RunJon

Member Data Documentation

bool CCron::m_bRunOnNextCall

protectedinherited

if set to true, RunJob() gets called on next invocation of run() despite the timeout

CModule* CTimer::m_pModule

protectedinherited

CString CTimer::m_sDescription

protectedinherited

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

Modules.h

Public Member Functions

Protected Member Functions

Protected Attributes

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation