CParticipant Class Reference

This class has get/set API's for various participant parameters. More...

#include <CParticipant.h>

Inheritance diagram for CParticipant:

Public Member Functions
bool	setLanguage (string szLanguage)
bool	setSentBy (string szBy)
bool	setCommonName (string szCommonName)
bool	setXparameters (string szXParameters)
bool	setCalAddress (string szCalAddress)
bool	setDirectoryParameter (string szDirParam)
const CParticipant &	operator= (const CParticipant &right)
string	getDirectoryParameter ()
string	getCalAddress ()
string	getXparameters ()
string	getCommonName ()
string	getSentBy ()
string	getLanguage ()
void	setMailTo (string szMailTo)
string	getMailTo ()
	CParticipant (string szSentBy, string szCommonName, string szDirectoryParameter, string szLanguage, string szCalAddress, string szCXparameter, string szMailTo)
	CParticipant ()
	CParticipant (CParticipant &Cparef)
virtual	~CParticipant ()
string	toString ()
Private Attributes
string	szSentBy
string	szCommonName
string	szDirectoryParameter
string	szLanguage
string	szCalAddress
string	szCXparameter
string	szMailTo

---

Detailed Description

This class has get/set API's for various participant parameters.

CParticipant class

---

Constructor & Destructor Documentation

CParticipant::CParticipant	(	string	szSentBy,
		string	szCommonName,
		string	szDirectoryParameter,
		string	szLanguage,
		string	szCalAddress,
		string	szCXparameter,
		string	szMailTo
	)

Parameterized constructor for CParticipant

CParticipant parameterised constructor for CParticipant

CParticipant::CParticipant

(

)

default constructor for CParticipant

CParticipant Default constructor for CParticipant

CParticipant::CParticipant

(

CParticipant &

Cparef

)

copy Constructor

CParticipant copy constructor

References szCalAddress, szCommonName, szCXparameter, szDirectoryParameter, szLanguage, szMailTo, and szSentBy.

CParticipant::~CParticipant

(

)

[virtual]

destructor for CParticipant

~CParticipant Default destructor for CParticipant

---

Member Function Documentation

bool CParticipant::setLanguage

(

string

szLanguage

)

Parameters:

string

Language parameter

Returns:

bool indicates whether operation is successful or not

This function will be used to set the language parameter of participant

header files setLanguage

Parameters:

string

Language parameter

Returns:

bool indicates whether operation is successful or not

This function will be used to set the language parameter of participant

Referenced by CComponentDetails::convertParamToAttendee(), CComponentDetails::convertParamToOrganizer(), ICalConverter::getAttendeeFromIcal(), and ICalConverter::getOrganizerFromIcal().

bool CParticipant::setSentBy

(

string

szSentBy

)

Parameters:

string

SentBy parameter

Returns:

bool indicates whether operation is successful or not

This function will be used to set the sentby parameter of participant

setSentBy

Parameters:

string

SentBy parameter

Returns:

bool indicates whether operation is successful or not

This function will be used to set the sentby parameter of participant

Referenced by CComponentDetails::convertParamToAttendee(), CComponentDetails::convertParamToOrganizer(), and ICalConverter::getOrganizerFromIcal().

bool CParticipant::setCommonName

(

string

szCommonName

)

Parameters:

string

common-name parameter

Returns:

bool indicates whether operation is successful or not

This function will be used to set the common-name parameter of participant

setCommonName

Parameters:

string

common-name parameter

Returns:

bool indicates whether operation is successful or not

This function will be used to set the common-name parameter of participant

Referenced by CComponentDetails::convertParamToAttendee(), CComponentDetails::convertParamToOrganizer(), and ICalConverter::getOrganizerFromIcal().

bool CParticipant::setXparameters

(

string

szCXparameter

)

Parameters:

string

szxParameters parameter

Returns:

bool indicates whether operation is successful or not

This function will be used to set the x-parameter of participant

setXparameters

Parameters:

string

X-PARAMETER parameter

Returns:

bool indicates whether operation is successful or not

This function will be used to set the x-parameter of participant

bool CParticipant::setCalAddress

(

string

szCalAddress

)

Parameters:

string

cal-Address parameter

Returns:

bool indicates whether operation is successful or not

This function will be used to set the Cal-Address parameter of participant

setCalAddress

Parameters:

string

cal-Address parameter

Returns:

bool indicates whether operation is successful or not

This function will be used to set the Cal-Address parameter of participant

bool CParticipant::setDirectoryParameter

(

string

szDirectoryParameter

)

Parameters:

string

directory name parameter

Returns:

bool indicates whether operation is successful or not

This function will be used to set the directory parameter of participant

setDirectoryParameter

Parameters:

string

directory name parameter

Returns:

bool indicates whether operation is successful or not

This function will be used to set the directory parameter of participant

Referenced by CComponentDetails::convertParamToAttendee(), CComponentDetails::convertParamToOrganizer(), ICalConverter::getAttendeeFromIcal(), and ICalConverter::getOrganizerFromIcal().

const CParticipant & CParticipant::operator=

(

const CParticipant &

right

)

overloaded assignment operator

References szCalAddress, szCommonName, szCXparameter, szDirectoryParameter, szLanguage, szMailTo, and szSentBy.

Referenced by COrganizer::operator=(), and CAttendee::operator=().

string CParticipant::getDirectoryParameter

(

)

Returns:

string directory name parameter

This function will be used to get the directory parameter of participant

getDirectoryParameter

Returns:

string directory name parameter

This function will be used to get the directory parameter of participant

References szDirectoryParameter.

Referenced by CCalendar::addOrganizer(), ICalConverter::getIcalAttendee_ical(), ICalConverter::getIcalOrganizer(), COrganizer::toString(), and CAttendee::toString().

string CParticipant::getCalAddress

(

)

Parameters:

none

Returns:

string cal-Address parameter

This function will be used to get the Cal-Address parameter of participant

getCalAddress()

Parameters:

none

Returns:

string cal-Address parameter

This function will be used to get the Cal-Address parameter of participant

References szCalAddress.

Referenced by COrganizer::toString(), and CAttendee::toString().

string CParticipant::getXparameters

(

)

Parameters:

none

Returns:

string X-parameter

This function will be used to get the X-parameter of participant

getXparameters

Parameters:

none

Returns:

string X-parameter

This function will be used to get the X-parameter of participant

References szCXparameter.

Referenced by COrganizer::toString(), and CAttendee::toString().

string CParticipant::getCommonName

(

)

Parameters:

none

Returns:

string CommonName

This function will be used to get the Common-name of participant

getCommonName

Parameters:

none

Returns:

string CommonName

This function will be used to get the Common-name of participant

References szCommonName.

Referenced by CCalendar::addOrganizer(), ICalConverter::getIcalAttendee_ical(), ICalConverter::getIcalOrganizer(), COrganizer::toString(), and CAttendee::toString().

string CParticipant::getSentBy

(

)

Parameters:

none

Returns:

string sentBy

This function will be used to get the sentby of participant

getSentBy

Parameters:

none

Returns:

string sentBy

This function will be used to get the sentby of participant

References szSentBy.

Referenced by CCalendar::addOrganizer(), ICalConverter::getIcalAttendee_ical(), ICalConverter::getIcalOrganizer(), COrganizer::toString(), and CAttendee::toString().

string CParticipant::getLanguage

(

)

Parameters:

none

Returns:

string Language parameter

This function will be used to get the language parameter of participant

getLanguage Function to get the value of language parameter

Parameters:

none

Returns:

string String value

References szLanguage.

Referenced by CCalendar::addOrganizer(), ICalConverter::getIcalAttendee_ical(), ICalConverter::getIcalOrganizer(), COrganizer::toString(), and CAttendee::toString().

void CParticipant::setMailTo

(

string

szMailTo

)

Parameters:

string

szMailTo

Returns:

none Function used to set mailto parameter

setMailTo

Parameters:

string

szMailTo

Returns:

none Function used to set mailto parameter

Referenced by CComponentDetails::convertParamToAttendee(), CComponentDetails::convertParamToOrganizer(), ICalConverter::getAttendeeFromIcal(), ICalConverter::getOrganizerFromIcal(), CComponentDetails::retrieveAttendeeDetails(), and CComponentDetails::retrieveOrganizerDetails().

string CParticipant::getMailTo

(

)

Parameters:

none

Returns:

string szMailTo Function to retrieve MailTo from the class

getMailTo

Parameters:

none

Returns:

string szMailTo Function to retrieve MailTo from the class

Referenced by CCalendar::addOrganizer(), ICalConverter::getIcalAttendee_ical(), ICalConverter::getIcalAttendee_vcal(), ICalConverter::getIcalOrganizer(), COrganizer::toString(), and CAttendee::toString().

string CParticipant::toString

(

)

toString

Reimplemented in CAttendee, and COrganizer.

References szCalAddress, szCommonName, szCXparameter, szDirectoryParameter, szLanguage, and szSentBy.

---

Field Documentation

string CParticipant::szSentBy [private]

SentBy parameter

Referenced by CParticipant(), getSentBy(), operator=(), and toString().

string CParticipant::szCommonName [private]

Common name

Referenced by CParticipant(), getCommonName(), operator=(), and toString().

string CParticipant::szDirectoryParameter [private]

Directory parameter

Referenced by CParticipant(), getDirectoryParameter(), operator=(), and toString().

string CParticipant::szLanguage [private]

Language paramter

Referenced by CParticipant(), getLanguage(), operator=(), and toString().

string CParticipant::szCalAddress [private]

Address

Referenced by CParticipant(), getCalAddress(), operator=(), and toString().

string CParticipant::szCXparameter [private]

CXParameter

Referenced by CParticipant(), getXparameters(), operator=(), and toString().

---

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

• include/CParticipant.h
• src/CParticipant.cpp