SallyAPI::Scheduler::CScheduler Class Reference

Scheduler. More...

#include <Scheduler.h>

List of all members.

Public Member Functions
	CScheduler (SallyAPI::GUI::CAppBase *reporterWindow, int reporterId, int messageId, const std::string &identifier, int runEveryDays)
	Constructor.
	~CScheduler ()
	Destructor.
SallyAPI::GUI::CAppBase *	GetReporterWindow ()
	Gets the reporter window.
std::string	GetIdentifier ()
	Gets the identifier.
int	GetReporterId ()
	Gets the reporter identifier.
int	GetMessageId ()
	Gets the message identifier.
int	GetRunEveryDays ()
	Gets the run every days.
void	SetRunning (bool running)
	Sets a running.
bool	IsRunning ()
	Query if this object is running.
SYSTEMTIME	GetStartTime ()
	Gets the start time.
SallyAPI::Scheduler::SCHEDULER_STATUS	GetStatus ()
	Gets the status.
void	SetStatus (SallyAPI::Scheduler::SCHEDULER_STATUS status)
	Sets a status.

---

Detailed Description

Scheduler.

Author:

Christian Knobloch

Date:

19.04.2010

---

Constructor & Destructor Documentation

CScheduler::CScheduler	(	SallyAPI::GUI::CAppBase *	reporterWindow,
		int	reporterId,
		int	messageId,
		const std::string &	identifier,
		int	runEveryDays
	)

Constructor.

Author:

Christian Knobloch

Date:

19.04.2010

Parameters:

[in,out]	reporterWindow	If non-null, the reporter window.
	reporterId	Identifier for the reporter.
	messageId	Identifier for the message.
	identifier	The identifier.
	runEveryDays	The run every in days.

CScheduler::~CScheduler

(

)

Destructor.

Author:

Christian Knobloch

Date:

19.04.2010

---

Member Function Documentation

std::string CScheduler::GetIdentifier

(

)

Gets the identifier.

Author:

Christian Knobloch

Date:

19.04.2010

Returns:

The identifier.

int CScheduler::GetMessageId

(

)

Gets the message identifier.

Author:

Christian Knobloch

Date:

19.04.2010

Returns:

The message identifier.

int CScheduler::GetReporterId

(

)

Gets the reporter identifier.

Author:

Christian Knobloch

Date:

19.04.2010

Returns:

The reporter identifier.

SallyAPI::GUI::CAppBase * CScheduler::GetReporterWindow

(

)

Gets the reporter window.

Author:

Christian Knobloch

Date:

19.04.2010

Returns:

null if it fails, else the reporter window.

int CScheduler::GetRunEveryDays

(

)

Gets the run every days.

Author:

Christian Knobloch

Date:

19.04.2010

Returns:

The run every days.

SYSTEMTIME CScheduler::GetStartTime

(

)

Gets the start time.

Author:

Christian Knobloch

Date:

19.04.2010

Returns:

The start time.

SallyAPI::Scheduler::SCHEDULER_STATUS CScheduler::GetStatus

(

)

Gets the status.

Author:

Christian Knobloch

Date:

01.04.2011

Returns:

null if it fails, else the status.

bool CScheduler::IsRunning

(

)

Query if this object is running.

Author:

Christian Knobloch

Date:

19.04.2010

Returns:

true if running, false if not.

void CScheduler::SetRunning

(

bool

running

)

Sets a running.

Author:

Christian Knobloch

Date:

19.04.2010

Parameters:

running

true to running.

void CScheduler::SetStatus

(

SallyAPI::Scheduler::SCHEDULER_STATUS

status

)

Sets a status.

Author:

Christian Knobloch

Date:

01.04.2011

Parameters:

[in,out]

status

If non-null, the status.

---

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

• D:/source/c++/Programme/sally/sally/sallyAPI/Scheduler.h
• D:/source/c++/Programme/sally/sally/sallyAPI/Scheduler.cpp