CParameters Class Reference

This class contains the API's to get/set the parameters for the standard properties of event/todo/journal. More...

#include <CParameters.h>

Public Member Functions
	CParameters ()
	CParameters (CParameters &)
	~CParameters ()
bool	setParamName (string szParamName)
string	getParamName ()
bool	setParamValue (ParamType valueType)
ParamType	getParamValue ()
int	getDataType (string szPropParam)
const CParameters &	operator= (const CParameters &right)
string	toString ()
Private Attributes
string	szParamName
ParamType	valueType

---

Detailed Description

This class contains the API's to get/set the parameters for the standard properties of event/todo/journal.

CParameters class

---

Constructor & Destructor Documentation

CParameters::CParameters

(

)

This is the defult constructor for CParameters class

CParameters Default constructor for CParameters

CParameters::CParameters

(

CParameters &

ref

)

Copy Constructor

CParameters copy constructor

References szParamName, and valueType.

CParameters::~CParameters

(

)

This is the defult destructor for CParameters class

~CParameters Default destructor for CParameters

---

Member Function Documentation

bool CParameters::setParamName

(

string

szParamName

)

Parameters:

szParamName

string

Returns:

bool

This function is used to set the param name.

setParamName()

Referenced by CCalendar::addAttendeeDetails(), CCalendar::addOrganizer(), ICalConverter::getAlterFromIcal(), ICalConverter::getFMTypeFromIcal(), ICalConverter::getLanguageFromIcal(), CComponentDetails::getParameter(), ICalConverter::getParameters(), ICalConverter::getRelationshipParamFromICal(), and CComponentDetails::retrieveParameterDetails().

string CParameters::getParamName

(

)

Returns:

string

This function is used to return the param name.

getParamname()

References szParamName.

Referenced by CComponentDetails::getParameter(), and CComponentDetails::retrieveParameterDetails().

bool CParameters::setParamValue

(

ParamType

valueType

)

Parameters:

valueType

ParamType

Returns:

bool

This function is used to set the param value.

setParamValue()

Referenced by CCalendar::addAttendeeDetails(), CCalendar::addOrganizer(), ICalConverter::getAlterFromIcal(), ICalConverter::getFMTypeFromIcal(), ICalConverter::getLanguageFromIcal(), CComponentDetails::getParameter(), ICalConverter::getRelationshipParamFromICal(), and CComponentDetails::retrieveParameterDetails().

ParamType CParameters::getParamValue

(

)

Returns:

ParamType

This function is used to return the param value.

getParamValue()

References valueType.

int CParameters::getDataType

(

string

szPropParam

)

Parameters:

szPropParam

string

Returns:

int

This function returns the Type of the the given parameter (INTEGER/STRING/BOOL)

Referenced by CComponentDetails::getParameter(), and CComponentDetails::retrieveParameterDetails().

const CParameters & CParameters::operator=

(

const CParameters &

right

)

Parameters:

Constant

reference to CParameters

Returns:

Reference to CParameters

Overloaded assignment operator for the class

overloaded assignment operator

References szParamName, and valueType.

string CParameters::toString

(

)

toString

References szParamName, and valueType.

---

Field Documentation

string CParameters::szParamName [private]

param name

Referenced by CParameters(), getParamName(), operator=(), and toString().

ParamType CParameters::valueType [private]

value Type

Referenced by CParameters(), getParamValue(), operator=(), and toString().

---

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

• include/CParameters.h
• src/CParameters.cpp