LibICal::ICalSpanList Class Reference

#include <icalspanlist_cxx.hpp>

Public Member Functions
std::vector< int >	as_vector (int delta_t)
	Returns a summary of events over delta_t.
void	dump ()
VComponent *	get_vfreebusy (const char *organizer, const char *attendee)
	Returns a VFREEBUSY component for the object.
	ICalSpanList (const ICalSpanList &v)
	ICalSpanList (icalcomponent *comp)
	Constructor.
	ICalSpanList (icalset *set, const icaltimetype &start, const icaltimetype &end)
	ICalSpanList (VComponent &comp)
	Constructor.
	operator icalspanlist * ()
ICalSpanList &	operator= (const ICalSpanList &)
	~ICalSpanList ()

Detailed Description

This class wraps the icalspanlist routines in libicalss

Errors within libicalss are propagated via exceptions of type icalerrorenum. See icalerror.h for the complete list of exceptions that might be thrown.

Definition at line 37 of file icalspanlist_cxx.hpp.

Constructor & Destructor Documentation

ICalSpanList() [1/5]

ICalSpanList::ICalSpanList

(

)

Definition at line 21 of file icalspanlist_cxx.cpp.

ICalSpanList() [2/5]

ICalSpanList::ICalSpanList

(

const ICalSpanList &

v

)

Definition at line 27 of file icalspanlist_cxx.cpp.

ICalSpanList() [3/5]

ICalSpanList::ICalSpanList	(	icalset *	set,
		const icaltimetype &	start,
		const icaltimetype &	end )

Constructs an ICalSpanList from an icalset

Construct an ICalSpanList from an icalset

Parameters

set	The icalset containing the VEVENTS
start	Designated start of the spanlist
end	Designated end of the spanlist

Definition at line 40 of file icalspanlist_cxx.cpp.

ICalSpanList() [4/5]

ICalSpanList::ICalSpanList ( icalcomponent * comp )

explicit

Constructor.

Constructs an ICalSpanList from the VFREEBUSY chunk of an icalcomponent

Parameters

comp	A valid icalcomponent with a VFREEBUSY section

Definition at line 52 of file icalspanlist_cxx.cpp.

ICalSpanList() [5/5]

ICalSpanList::ICalSpanList ( VComponent & comp )

explicit

Constructor.

Constructs an ICalSpanList from the VFREEBUSY chunk of a vcomponent

Parameters

comp	A valid VComponent with a VFREEBUSY section

Definition at line 63 of file icalspanlist_cxx.cpp.

~ICalSpanList()

ICalSpanList::~ICalSpanList

(

)

Destructor

Definition at line 77 of file icalspanlist_cxx.cpp.

Member Function Documentation

as_vector()

std::vector< int > ICalSpanList::as_vector

(

int

delta_t

)

Returns a summary of events over delta_t.

Returns a vector of the number of events over delta t

Parameters

delta_t

Number of seconds to divide the spanlist time period into.

This method calculates the total number of events in each time slot of delta_t seconds.

See also

icalspanlist_as_freebusy_matrix()

Definition at line 120 of file icalspanlist_cxx.cpp.

dump()

void ICalSpanList::dump

(

)

Dumps the spanlist to STDOUT

Definition at line 71 of file icalspanlist_cxx.cpp.

get_vfreebusy()

VComponent * ICalSpanList::get_vfreebusy	(	const char *	organizer,
		const char *	attendee )

Returns a VFREEBUSY component for the object.

Returns a VFREEBUSY icalcomponent

See also

icalspanlist_as_vfreebusy()

Definition at line 90 of file icalspanlist_cxx.cpp.

operator icalspanlist *()

LibICal::ICalSpanList::operator icalspanlist * ( )

inline

Returns the base data when casting

Definition at line 61 of file icalspanlist_cxx.hpp.