CAlarm Class Reference

This class contains the API's to interact with alarm daemon as well store the alarm data's in the local calendar database. More...

#include <CAlarm.h>

Inheritance diagram for CAlarm:

Public Member Functions
	CAlarm ()
	CAlarm (CAlarm &ref)
	~CAlarm ()
const CAlarm &	operator= (const CAlarm &right)
	CAlarm (int iTrigger, int iRepeat, int iDuration, int iAction, string szAttach)
	CAlarm (int iTrigger, int iDuration)
bool	setTrigger (int)
int	getTrigger ()
bool	setRepeat (int iRepeat)
int	getRepeat ()
bool	setDuration (int iDuration)
int	getDuration ()
bool	setAction (int iAction)
int	getAction ()
bool	setAttach (string szAttach)
string	getAttach ()
vector< long >	getCookie ()
bool	setCookie (vector< long > icookie)
long	addAlarmEvent (time_t event_time, string message, string location, time_t dateStart, time_t dateEnd, string compId, int iCalendarId, string szDescription, int iType, int &pErrorCode)
long	registerAlarmForAutoDeletion (time_t alarm_time, int &pErrorCode)
int	deleteAlarmEvent (long cookie, int &pErrorCode)
long	modifyAlarmEvent (long oldcookie, time_t modify_time, string message, string location, time_t dateStart, time_t dateEnd, string sCompId, int iCalendarId, string szDescription, int iType, int &pErrorCode)
Private Attributes
int	iTrigger
int	iRepeat
int	iDuration
int	iAction
vector< long >	vcookie
string	szAttach

---

Detailed Description

This class contains the API's to interact with alarm daemon as well store the alarm data's in the local calendar database.

CAlarm class

---

Constructor & Destructor Documentation

CAlarm::CAlarm

(

)

default constructor

CAlarm::CAlarm

(

CAlarm &

ref

)

copy constructor

CAlarm::~CAlarm

(

)

default destructor

CAlarm::CAlarm	(	int	iTrigger,
		int	iRepeat,
		int	iDuration,
		int	iAction,
		string	szAttach
	)

parameterised constructor

Parameters:

	trigger	an integer
	Repeat	an integer
	duration	an integer
	action	an integer
	attachments	a string

Returns:

none

CAlarm::CAlarm	(	int	iTrigger,
		int	iDuration
	)

CAlarm Parameterized constructor

Parameters:

	iTrigger	Integer time in time_t format used to know the time of occurance of alarm duration Duration of alarm
	cookie	Alarm cookie value

Returns:

none

---

Member Function Documentation

const CAlarm & CAlarm::operator=

(

const CAlarm &

right

)

overloaded assignment operator

bool CAlarm::setTrigger

(

int

)

setTrigger

Parameters:

int

Returns:

TRUE/FALSE

int CAlarm::getTrigger

(

)

getTrigger

Parameters:

none

Returns:

int

bool CAlarm::setRepeat

(

int

iRepeat

)

setRepeat

Parameters:

int

Returns:

TRUE/FALSE

int CAlarm::getRepeat

(

)

getRepeat

Parameters:

none

Returns:

int

bool CAlarm::setDuration

(

int

iDuration

)

setDuration

Parameters:

int

Returns:

TRUE/FALSE

int CAlarm::getDuration

(

)

getDuration

Parameters:

none

Returns:

int

bool CAlarm::setAction

(

int

iAction

)

setAction

Parameters:

int

Returns:

TRUE/FALSE

int CAlarm::getAction

(

)

getAction

Parameters:

none

Returns:

int sdfsd

bool CAlarm::setAttach

(

string

szAttach

)

setAttach

Parameters:

int

Returns:

TRUE/FALSE

string CAlarm::getAttach

(

)

getAttach

Parameters:

none

@return string

vector< long > CAlarm::getCookie

(

)

getCookie()

Parameters:

None

Returns:

vector<integer> cookie for an Alarm

Returns the cookie value for an Alarm

bool CAlarm::setCookie

(

vector< long >

icookie

)

setCookie(int)

Parameters:

vector<integer>

cookie value of an alarm

Returns:

boolean value to indicate success or failure

Sets the cookie value of an Alarm

long CAlarm::addAlarmEvent	(	time_t	event_time,
		string	message,
		string	location,
		time_t	dateStart,
		time_t	dateEnd,
		string	compId,
		int	iCalendarId,
		string	szDescription,
		int	iType,
		int &	pErrorCode
	)			[virtual]

addAlarmEvent Function to add the alarm event

Parameters:

	event_time	Event time in time_t format
	message	Event summary displays in alarm message
	location	Event location displays in alarm message
	dateStart	Event start date
	dateEnd	Event end date
	compId	component Id
	iCalendarId	Calendar Id
	szdescription	Description of the entry
	iType	Component Type
	pErrorCode	reference to integer

Returns:

long Alarm cookie value

Implements CAlarmIface.

long CAlarm::registerAlarmForAutoDeletion	(	time_t	alarm_time,
		int &	pErrorCode
	)

registerAlarmForAutoDeletion Function to register an alarm for automatic deletion of events.

Parameters:

	alarm_time	Event time in time_t format
	pErrorCode	refece to intger error code

Returns:

long Alarm cookie value

int CAlarm::deleteAlarmEvent	(	long	cookie,
		int &	pErrorCode
	)			[virtual]

deleteAlarmEvent Function to delete the alarm event

Parameters:

	long	Alarm cookie value
	pErrorCode	refece to intger error code

Returns:

int Return value for delete alarm event

Implements CAlarmIface.

long CAlarm::modifyAlarmEvent	(	long	oldcookie,
		time_t	modify_time,
		string	message,
		string	location,
		time_t	dateStart,
		time_t	dateEnd,
		string	sCompId,
		int	iCalendarId,
		string	szDescription,
		int	iType,
		int &	pErrorCode
	)			[virtual]

modifyAlarmEvent

Parameters:

	oldcookie	Old cookie value
	modify_time	Event time in time_t format
	message	Event summary displays in alarm message
	location	Event location displays in alarm message
	dateStart	Event start date
	dateEnd	Event end date
	iCalendarId	Calendar Id string
	iType	component type
	pErrorCode	reference to integer

Returns:

long New Alarm cookie value

Function to modify the alarm event

Implements CAlarmIface.

---

Field Documentation

int CAlarm::iTrigger [private]

Trigger parameter as per RFC

int CAlarm::iRepeat [private]

Alarm repeat parameter

int CAlarm::iDuration [private]

Alarm Duration

int CAlarm::iAction [private]

Alarm action

vector< long > CAlarm::vcookie [private]

Cookies vector to store them in database

string CAlarm::szAttach [private]

Attachements

---

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

• include/CAlarm.h
• src/CAlarm.cpp

---