CRecurrence Class Reference

This contains the recurrence information. More...

#include <CRecurrence.h>

Public Member Functions
bool	setRecurrenceRule (vector< CRecurrenceRule * >VRRuleList)
vector< CRecurrenceRule * >	getRecurrenceRule ()
vector< string >	getErule ()
vector< string >	getRrule ()
	CRecurrence (CRecurrence &ref)
bool	setRrule (vector< string > vRRuleList)
bool	setErule (vector< string > vERuleList)
bool	setRDays (vector< string > vRecRuleList)
vector< string >	getRDays ()
bool	setEDays (vector< string > vExceptionDateList)
vector< string >	getEDays ()
bool	setRecurId (int iRId)
int	getRecurId ()
bool	setRtype (int iRType)
int	getRtype ()
	CRecurrence (vector< string > vRRuleList, int iRId)
vector< time_t >	generateInstanceTimes (time_t iViewBegin, time_t iViewEnd, time_t iDateStart, int eventSpan)
	CRecurrence ()
CRecurrence &	operator= (const CRecurrence &right)
	~CRecurrence ()
Private Attributes
vector< CRecurrenceRule * >	vRecrRuleList
vector< string >	vExceptionDateList
vector< string >	vRecRuleList
int	iRType
int	iRecurId

---

Detailed Description

This contains the recurrence information.

CRecurrence

---

Constructor & Destructor Documentation

CRecurrence::CRecurrence

(

CRecurrence &

ref

)

CRecurrence(CRecurrence & ref) copy constructor for CRecurrence class

CRecurrence::CRecurrence	(	vector< string >	vRRuleList,
		int	iRId
	)

CRecurrence(string,int)

Parameters:

	vector	<string> Rrule recurrence rule
	int	recurrence id.

This is overloaded constructor for recurrence class

CRecurrence::CRecurrence

(

)

CRecurrence()

This is default constructor for recurrence class

CRecurrence::~CRecurrence

(

)

~CRecurrence()

This is destructor for recurrence class

---

Member Function Documentation

bool CRecurrence::setRecurrenceRule

(

vector< CRecurrenceRule * >

VRRuleList

)

setRecurrenceRule

Parameters:

vector

<CRecurrenceRule*> pointer to CRecurrenceRule object

Returns:

boolean status of the operation Function used to set CRecurrrencRule in to CRecurrence(this) class

vector< CRecurrenceRule * > CRecurrence::getRecurrenceRule

(

)

getRecurrenceRule

Parameters:

NONE

Returns:

vector <CRecurrenceRule*> pointer to CRecurrenceRule object Function used to retrieve CRecurrrencRule from CRecurrence(this) class

vector< string > CRecurrence::getErule

(

)

getErule Function to get the recurrence rule of a recursive event.

Parameters:

none

Returns:

vector string type of calendar recurrence rule only exception rules are retrieived here

this will call the getErule function in CRecurrenceRule object

vector< string > CRecurrence::getRrule

(

)

getRrule()

Parameters:

none

Returns:

vector string type of calendar recurrence rule

This function will be used to get the recurrence rule of a recursive event this list will include both recurrence rules and exception rules can be differentiated by type

this will call the getRrule function in CRecurrenceRule object

bool CRecurrence::setRrule

(

vector< string >

vRRuleList

)

setRrule()

Parameters:

string

type of calendar recurrence rule

Returns:

bool to indicate operation is successful or not

This function will be used to set the recurrence rule of a recursive event,todo or Journal

bool CRecurrence::setErule

(

vector< string >

vERuleList

)

setErule()

Parameters:

string

type of calendar exception recurrence rule

Returns:

bool to indicate operation is successful or not

This function will be used to set the Exception recurrence rule of a recursive event,todo or Journal Although not supposed to be useful from calendar might be significant from sync point of view.

bool CRecurrence::setRDays

(

vector< string >

vRecRuleList

)

setRDays()

Parameters:

vector

type of calendar recurrence dates

Returns:

bool to indicate operation is successful or not

This function will be used to set the Recursive days of a recursive event,todo or Journal Although not supposed to be useful from calendar might be significant from sync point of view.

vector< string > CRecurrence::getRDays

(

)

getRDays()

Parameters:

none

Returns:

vector type of calendar recurrence dates

This function will be used to get the Recursive days of a recursive event,todo or Journal Although not supposed to be useful from calendar might be significant from sync point of view.

bool CRecurrence::setEDays

(

vector< string >

vExceptionDateList

)

setEDays()

Parameters:

vector

type of calendar exception recurrence dates

Returns:

bool to indicate operation is successful or not

This function will be used to set the exception Recursive days of a recursive event,todo or Journal

vector< string > CRecurrence::getEDays

(

)

getEDays()

Parameters:

none

Returns:

vector type of calendar exception recursive dates

This function will be used to get the exception days of a recursive event,todo or Journal

bool CRecurrence::setRecurId

(

int

iRId

)

setRecurId()

Parameters:

int

recurrence id

Returns:

bool to indicate operation is successful or not

This function will be used to set the exception Recursive days of a recursive event,todo or Journal

int CRecurrence::getRecurId

(

)

getRecurId()

Parameters:

none

Returns:

int recurrence id.

This function will be used to set the exception Recursive days of a recursive event,todo or Journal

bool CRecurrence::setRtype

(

int

iRType

)

setRtype

Parameters:

:

int Type of recurrence .

Returns:

: bool to indicate the result of operation.

This function is used to set the Recurrence type value in Recurrence object. It is used for recurrence events and todos. It can take values like 'BY_DAILY' =1 'BY_WEEKLY' =2 'BY_MONTHLY'=3 and so on. For external events/todos the value should be set to 0.

int CRecurrence::getRtype

(

)

getRtype

Parameters:

:

NONE.

Returns:

: Int Type of internal recurrence.

This function is used to get the Recurrence type value in Recurrence object. It is used for recurrence events and todos. It can take values like 'BY_DAILY' =1 'BY_WEEKLY' =2 'BY_MONTHLY'=3 and so on. For external events/todos the value should be set to 0.

vector< time_t > CRecurrence::generateInstanceTimes	(	time_t	iViewBegin,
		time_t	iViewEnd,
		time_t	iDateStart,
		int	eventSpan
	)

generateInstanceTimes()

Parameters:

	iviewBegin	lower range of current view
	iviewEnd	higher range of current view
	ieventSpan	diff between date start and date end of original instance

Returns:

vector <time_t> values on which event has to happen

Function used to retrieve the recurrence dates

CRecurrence & CRecurrence::operator=

(

const CRecurrence &

right

)

overloaded assignment operator

---

Field Documentation

vector< CRecurrenceRule * > CRecurrence::vRecrRuleList [private]

Vector recurrence rule

vector< string > CRecurrence::vExceptionDateList [private]

Exception date list

vector< string > CRecurrence::vRecRuleList [private]

Recurrence rule list

int CRecurrence::iRType [private]

recurrence type

int CRecurrence::iRecurId [private]

Recurrence ID

---

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

• include/CRecurrence.h
• src/CRecurrence.cpp

---