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, int is_day, string sTzid)
void	generateInstanceTimes (time_t iViewBegin, time_t iViewEnd, time_t iDateStart, int eventSpan, int is_day, string sTzid, vector< time_t > &instance_times, bool sort_times=true)
bool	checkInstances (time_t iViewBegin, time_t iViewEnd, time_t iDateStart, int eventSpan, int is_day, string sTzid)
	CRecurrence ()
CRecurrence &	operator= (const CRecurrence &right)
	~CRecurrence ()
string	toString ()
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(CRecurrence & ref) copy constructor for CRecurrence class

References getRecurrenceRule(), iRecurId, iRType, vExceptionDateList, vRecrRuleList, and vRecRuleList.

CRecurrence::CRecurrence	(	vector< string >	vRRule,
		int	iRecurId
	)

CRecurrence(string,int)

Parameters:

	vector	<string> Rrule recurrence rule
	int	recurrence id.

This is overloaded constructor for recurrence class

CRecurrence This is overloaded constructor for recurrence class

Parameters:

	Rrule	recurrence rule
	int	recurrence id.

References iRType, and setRrule().

CRecurrence::CRecurrence

(

)

CRecurrence()

This is default constructor for recurrence class

CRecurrence() This is default constructor for recurrence class

References iRType.

CRecurrence::~CRecurrence

(

)

~CRecurrence()

This is destructor for recurrence class

~CRecurrence() This is destructor for recurrence class

References vExceptionDateList, vRecrRuleList, and vRecRuleList.

---

Member Function Documentation

bool CRecurrence::setRecurrenceRule

(

vector< CRecurrenceRule * >

vRRule

)

setRecurrenceRule

Parameters:

vector

<CRecurrenceRule*> pointer to CRecurrenceRule object

Returns:

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

header files setRecurrenceRule

Parameters:

vector

CRecurrenceRule* pointers to CRecurrenceRule object

Returns:

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

References vRecrRuleList.

Referenced by ICalConverter::importEventRecurrence().

vector< CRecurrenceRule * > CRecurrence::getRecurrenceRule

(

)

getRecurrenceRule

Parameters:

NONE

Returns:

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

getRecurrenceRule

Parameters:

NONE

Returns:

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

References vRecrRuleList.

Referenced by CRecurrence(), and CComponent::retrieveRecurreceRuleObject().

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

References vRecrRuleList.

Referenced by CCalendar::addRecurrence(), generateInstanceTimes(), and CCalendar::modifyRecurrence().

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

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

Parameters:

none

Returns:

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

this will call the getRrule function in CRecurrenceRule object

References vRecrRuleList.

Referenced by CCalendar::addRecurrence(), generateInstanceTimes(), and CCalendar::modifyRecurrence().

bool CRecurrence::setRrule

(

vector< string >

vRules

)

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

setRrule Function to set the recurrence rule of a recursive event,todo or Journal

Parameters:

vector

string type of calendar recurrence rule

Returns:

bool to indicate operation is successful or not

References vRecrRuleList.

Referenced by CRecurrence(), CCalendar::getEvent(), CMulticalendar::getEventInList(), CCalendar::getEvents(), CComponent::getRecurrenceProperties(), and CMulticalendar::localBdayEventFromRemoteId().

bool CRecurrence::setErule

(

vector< string >

vRules

)

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.

setErule Function 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.

Parameters:

vector

<string> type of calendar exception recurrence rule

Returns:

bool to indicate operation is successful or not

References vRecrRuleList.

Referenced by CCalendar::getEvent(), CMulticalendar::getEventInList(), CCalendar::getEvents(), CComponent::getRecurrenceProperties(), and CMulticalendar::localBdayEventFromRemoteId().

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.

setRDays Function 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.

Parameters:

vector

type of calendar recurrence dates

Returns:

bool to indicate operation is successful or not

Referenced by CCalendar::getEvent(), CMulticalendar::getEventInList(), CCalendar::getEvents(), CComponent::getRecurrenceProperties(), ICalConverter::importEventRecurrence(), and CMulticalendar::localBdayEventFromRemoteId().

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.

getRDays() Function 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.

Parameters:

none

Returns:

vector type of calendar recurrence dates

References vRecRuleList.

Referenced by CCalendar::addRecurrence(), generateInstanceTimes(), and CCalendar::modifyRecurrence().

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

Referenced by CCalendar::getEvent(), CMulticalendar::getEventInList(), CCalendar::getEvents(), CComponent::getRecurrenceProperties(), ICalConverter::importEventRecurrence(), and CMulticalendar::localBdayEventFromRemoteId().

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

References vExceptionDateList.

Referenced by CCalendar::addRecurrence(), generateInstanceTimes(), and CCalendar::modifyRecurrence().

bool CRecurrence::setRecurId

(

int

iRecurId

)

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

setRecurId Function to set the exception Recursive days of a recursive event,todo or Journal

Parameters:

int

recurrence id

Returns:

bool (TRUE/FALSE)

Referenced by CCalendar::getEvent(), CMulticalendar::getEventInList(), CCalendar::getEvents(), CComponent::getRecurrenceProperties(), ICalConverter::importEventRecurrence(), and CMulticalendar::localBdayEventFromRemoteId().

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

getRecurId Function to set the exception Recursive days of a recursive event,todo or Journal

Parameters:

none

Returns:

int Recurrence ID

References iRecurId.

Referenced by CCalendar::addRecurrence(), and CCalendar::modifyRecurrence().

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.

Referenced by CCalendar::getEvent(), CMulticalendar::getEventInList(), CCalendar::getEvents(), CComponent::getRecurrenceProperties(), ICalConverter::importEventRecurrence(), CMulticalendar::localBdayEventFromRemoteId(), and CComponent::setRtype().

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.

References iRType.

Referenced by CCalendar::addRecurrence(), CComponent::getRtype(), ICalConverter::importEventRecurrence(), and CCalendar::modifyRecurrence().

vector< time_t > CRecurrence::generateInstanceTimes	(	time_t	iViewBegin,
		time_t	iViewEnd,
		time_t	iDateStart,
		int	ieventSpan,
		int	is_day,
		string	sTzid
	)

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 !!! DEPRECATED !!!

generateInstanceTimes()

Parameters:

	viewBegin	lower range of current view
	viewEnd	higher range of current view
	int	iEventSpan diff between datestart and dateend of original instance

Returns:

vector <time_t> values on which event has to happen

Function used to retrieve the recurrence dates

Referenced by checkInstances(), and CComponent::generateInstanceTimes().

void CRecurrence::generateInstanceTimes	(	time_t	iViewBegin,
		time_t	iViewEnd,
		time_t	iDateStart,
		int	eventSpan,
		int	is_day,
		string	sTzid,
		vector< time_t > &	instance_times,
		bool	sort_times = true
	)

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
	instance_times	values on which event has to happen
	sort_times	true if instance times must be sorted

Function used to retrieve the recurrence dates

References getEDays(), getErule(), getRDays(), CMulticalendar::getRecurrentTimes(), getRrule(), and CMulticalendar::MCInstance().

bool CRecurrence::checkInstances	(	time_t	iViewBegin,
		time_t	iViewEnd,
		time_t	iDateStart,
		int	eventSpan,
		int	is_day,
		string	sTzid
	)

checkInstances()

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:

true if an instance found

Function used to check if any instance of this event occurs in the given interval

checkInstances()

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:

true or false

Function used to check if any instance of this event occurs in the given interval

References generateInstanceTimes().

Referenced by CComponent::getInstanceNumber().

CRecurrence & CRecurrence::operator=

(

const CRecurrence &

right

)

overloaded assignment operator

References iRecurId, iRType, vExceptionDateList, vRecrRuleList, and vRecRuleList.

string CRecurrence::toString

(

)

toString

References iRecurId, iRType, vExceptionDateList, vRecrRuleList, and vRecRuleList.

Referenced by CTodo::toString(), CJournal::toString(), CEvent::toString(), CComponentDetails::toString(), CComponent::toString(), and CBdayEvent::toString().

---

Field Documentation

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

Vector recurrence rule

Referenced by CRecurrence(), getErule(), getRecurrenceRule(), getRrule(), operator=(), setErule(), setRecurrenceRule(), setRrule(), toString(), and ~CRecurrence().

vector< string > CRecurrence::vExceptionDateList [private]

Exception date list

Referenced by CRecurrence(), getEDays(), operator=(), toString(), and ~CRecurrence().

vector< string > CRecurrence::vRecRuleList [private]

Recurrence rule list

Referenced by CRecurrence(), getRDays(), operator=(), toString(), and ~CRecurrence().

int CRecurrence::iRType [private]

recurrence type

Referenced by CRecurrence(), getRtype(), operator=(), and toString().

int CRecurrence::iRecurId [private]

Recurrence ID

Referenced by CRecurrence(), getRecurId(), operator=(), and toString().

---

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

• /home/bifh2/fremantle-i386-fremantle-pe1.cs2007q3/work/calendar-backend-0.8/include/CRecurrence.h
• /home/bifh2/fremantle-i386-fremantle-pe1.cs2007q3/work/calendar-backend-0.8/src/CRecurrence.cpp