The base class for calendar objects. More...

#include </home/doug/src/SoftwareAndServices/libSaSiCalendar/iCalendar.hpp>

Inheritance diagram for SoftwareAndServices::Library::iCalendar::iCalendar:

Collaboration diagram for SoftwareAndServices::Library::iCalendar::iCalendar:

Public Member Functions
	iCalendar ()
	iCalendar Constructor. More...

	iCalendar (iCalendar *ExistingiCalendarObject)
	iCalendar Constructor. More...

	iCalendar (icalbody *ExistingVCalendarObject)
	iCalendar Constructor. More...

virtual	~iCalendar ()
	iCalendar Destructor More...

bool	add (const iCalendar *anotheriCal)
	Add another iCalendar to this object. More...

bool	add (const icalbody *body)
	Add an icalbody to this iCalendar object. More...

bool	add (const component *comp)
	Add a component to this iCalendar object. More...

bool	add (const property *prop)
	Add a property to the iCalendar object. More...

virtual InstanceCount_t	decInstance () const
	Decrement the instance. More...

unsigned int	getBodyCount () const
	Get the number of icalbody objects in this object. More...

component *	getComponent (unsigned int nTh) const
	Return the nTh component. More...

component *	getComponent (Tokens_t typeToGet, unsigned int nTh) const
	Return the nTh component that is typeToGet. More...

unsigned int	getComponentCount () const
	Return the number of components in this object. More...

unsigned int	getComponentCount (Tokens_t typeToCount) const
	Return the number of components in this object of type typeToCount. More...

iCalendar *	getiCal (unsigned int nTh) const
	Get the nTh ical object. More...

icalbody *	getiCalBody (unsigned int nTh) const
	Get the nTh icalbody object. More...

unsigned int	getiCalCount () const
	Get the number of iCalender objects in this object. More...

virtual InstanceCount_t	getInstance () const

property *	getProperty (unsigned int nTh) const
	Return the nTh property. More...

unsigned int	getPropertyCount () const
	Return the number of properties in this object. More...

void *	getUserData () const
	Return the data set by a call to setUserData(). More...

virtual InstanceCount_t	incInstance () const
	Increment the instance. More...

void	operator delete (void *ToFree)

bool	parse (const char in, component errors)
	Parse a string of calendar data. More...

bool	parse (File in, component errors)
	Parse an open File. More...

bool	parse (Parse &in, component *errors)
	Parse the contents of a already initialized Parse() object that contains calendar data. More...

void	setUserData (const void *userData)
	User data associated with this object. More...

bool	sprint (String *Results) const
	Convert this object to an RFC-iCalendar formatted string. More...

bool	valid () const
	Do basic checking to determine if the data parsed looks like some kind of known iCalendar object. More...

Protected Attributes
icalbodyVec *	_bodyList

componentVec *	_componentList

iCalendarVec *	_icalList

propertyVec *	_propertyList

void *	_userData

Detailed Description

The base class for calendar objects.

Generally this would not be used by applications. Instead they would use libINET-iCalFile, libINET-iCalXML, and so on.

Definition at line 434 of file iCalendar.hpp.

Constructor & Destructor Documentation

◆ iCalendar() [1/3]

SoftwareAndServices::Library::iCalendar::iCalendar::iCalendar ( )

iCalendar Constructor.

◆ iCalendar() [2/3]

SoftwareAndServices::Library::iCalendar::iCalendar::iCalendar ( iCalendar * ExistingiCalendarObject )

iCalendar Constructor.

Parameters

ExistingiCalendarObject An existing VCALENDER/VCALSTORE object to be added to 'this' object.

◆ iCalendar() [3/3]

SoftwareAndServices::Library::iCalendar::iCalendar::iCalendar ( icalbody * ExistingVCalendarObject )

iCalendar Constructor.

Parameters

ExistingVCalendarObject An existing VCALENDER object to be added to 'this' object.

◆ ~iCalendar()

virtual SoftwareAndServices::Library::iCalendar::iCalendar::~iCalendar ( )

virtual

iCalendar Destructor

Member Function Documentation

◆ add() [1/4]

bool SoftwareAndServices::Library::iCalendar::iCalendar::add ( const iCalendar * anotheriCal )

Add another iCalendar to this object.

Parameters

anotheriCal the other iCalendar pointer.

Returns: TRUE if added.

◆ add() [2/4]

bool SoftwareAndServices::Library::iCalendar::iCalendar::add ( const icalbody * body )

Add an icalbody to this iCalendar object.

Parameters

body	The icalbody to add.

Returns: TRUE if added.

◆ add() [3/4]

bool SoftwareAndServices::Library::iCalendar::iCalendar::add ( const component * comp )

Add a component to this iCalendar object.

Parameters

comp	The component to add.

Returns: TRUE if added.

◆ add() [4/4]

bool SoftwareAndServices::Library::iCalendar::iCalendar::add ( const property * prop )

Add a property to the iCalendar object.

Parameters

prop	The property to add.

Returns: TRUE if added.

◆ decInstance()

virtual InstanceCount_t SoftwareAndServices::Library::Common::instance< iCalendar >::decInstance ( ) const

inlinevirtualinherited

Decrement the instance.

Returns: The instance count, after decrementing it.

Definition at line 129 of file instance.hpp.

◆ getBodyCount()

unsigned int SoftwareAndServices::Library::iCalendar::iCalendar::getBodyCount ( ) const

Get the number of icalbody objects in this object.

Returns: The number of icalbody objects in this object.

◆ getComponent() [1/2]

component* SoftwareAndServices::Library::iCalendar::iCalendar::getComponent ( unsigned int nTh ) const

Return the nTh component.

Parameters

nTh	nTh starts from zero.

Returns: NULL if not found, else the nTh component.

◆ getComponent() [2/2]

component* SoftwareAndServices::Library::iCalendar::iCalendar::getComponent	(	Tokens_t	typeToGet,
		unsigned int	nTh
	)		const

Return the nTh component that is typeToGet.

Parameters

typeToGet	Get the nTh component of this type.
nTh	nTh starts from zero.

Returns: NULL if not found, else the nTh component.

◆ getComponentCount() [1/2]

unsigned int SoftwareAndServices::Library::iCalendar::iCalendar::getComponentCount ( ) const

Return the number of components in this object.

Returns: The number of components in this object.

◆ getComponentCount() [2/2]

unsigned int SoftwareAndServices::Library::iCalendar::iCalendar::getComponentCount ( Tokens_t typeToCount ) const

Return the number of components in this object of type typeToCount.

Parameters

typeToCount Only count this kind of components in the results.

Returns: The number of components in this object.

◆ getiCal()

iCalendar* SoftwareAndServices::Library::iCalendar::iCalendar::getiCal ( unsigned int nTh ) const

Get the nTh ical object.

Parameters

nTh	nTh starts at zero for the first object.

Returns: NULL if the Nth iCalendar object does not exist.

◆ getiCalBody()

icalbody* SoftwareAndServices::Library::iCalendar::iCalendar::getiCalBody ( unsigned int nTh ) const

Get the nTh icalbody object.

Parameters

nTh	nTh starts at zero for the first object.

Returns: NULL if the Nth icalbody object does not exist.

◆ getiCalCount()

unsigned int SoftwareAndServices::Library::iCalendar::iCalendar::getiCalCount ( ) const

Get the number of iCalender objects in this object.

Returns: The number of iCalendar objects in this object.

◆ getInstance()

virtual InstanceCount_t SoftwareAndServices::Library::Common::instance< iCalendar >::getInstance ( ) const

inlinevirtualinherited

Returns: The current instance count.

Definition at line 118 of file instance.hpp.

◆ getProperty()

property* SoftwareAndServices::Library::iCalendar::iCalendar::getProperty ( unsigned int nTh ) const

Return the nTh property.

Parameters

nTh	nTh starts from zero.

Returns: NULL if not found, else the nTh property.

◆ getPropertyCount()

unsigned int SoftwareAndServices::Library::iCalendar::iCalendar::getPropertyCount ( ) const

Return the number of properties in this object.

Returns: The number of properties in this object.

◆ getUserData()

void* SoftwareAndServices::Library::iCalendar::iCalendar::getUserData ( ) const

Return the data set by a call to setUserData().

Returns: The pointer set by a call to setUserData().

◆ incInstance()

virtual InstanceCount_t SoftwareAndServices::Library::Common::instance< iCalendar >::incInstance ( ) const

inlinevirtualinherited

Increment the instance.

Returns: The instance value, after incrementing it.

Definition at line 109 of file instance.hpp.

◆ parse() [1/3]

bool SoftwareAndServices::Library::iCalendar::iCalendar::parse	(	const char *	in,
		component *	errors
	)

Parse a string of calendar data.

Parameters

in	The already initialized Parse() object.
errors	An iCalendar formatted list of errors.

Returns: Returns the number of octets parsed.

See also: Parse()

◆ parse() [2/3]

bool SoftwareAndServices::Library::iCalendar::iCalendar::parse	(	File *	in,
		component *	errors
	)

Parse an open File.

Parameters

in	The already opened File that contains calendar data.
errors	An iCalendar formatted list of errors.

Returns: Returns the number of octets parsed.

See also: File()

◆ parse() [3/3]

bool SoftwareAndServices::Library::iCalendar::iCalendar::parse	(	Parse &	in,
		component *	errors
	)

Parse the contents of a already initialized Parse() object that contains calendar data.

Parameters

in	The already initialized Parse() object.
errors	An iCalendar formatted list of errors.

Returns: Returns the number of octets parsed.

See also: Parse()

◆ setUserData()

void SoftwareAndServices::Library::iCalendar::iCalendar::setUserData ( const void * userData )

User data associated with this object.

This is not iCal specific, it is to be used in any way needed by calling application.

Parameters

userData A pointer to any kind of data.

See also: getUserdata();

◆ sprint()

bool SoftwareAndServices::Library::iCalendar::iCalendar::sprint ( String * Results ) const

Convert this object to an RFC-iCalendar formatted string.

Parameters

Results A pointer to a String where the results will be appended to.

Returns: TRUE when something was added to Results.

◆ valid()

bool SoftwareAndServices::Library::iCalendar::iCalendar::valid ( ) const

Do basic checking to determine if the data parsed looks like some kind of known iCalendar object.

Returns: TRUE if it looks valid after parsing.

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

iCalendar.hpp

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ iCalendar() [1/3]

◆ iCalendar() [2/3]

◆ iCalendar() [3/3]

◆ ~iCalendar()

Member Function Documentation

◆ add() [1/4]

◆ add() [2/4]

◆ add() [3/4]

◆ add() [4/4]

◆ decInstance()

◆ getBodyCount()

◆ getComponent() [1/2]

◆ getComponent() [2/2]

◆ getComponentCount() [1/2]

◆ getComponentCount() [2/2]

◆ getiCal()

◆ getiCalBody()

◆ getiCalCount()

◆ getInstance()

◆ getProperty()

◆ getPropertyCount()

◆ getUserData()

◆ incInstance()

◆ parse() [1/3]

◆ parse() [2/3]

◆ parse() [3/3]

◆ setUserData()

◆ sprint()

◆ valid()