Software and Services, Portable Libraries  2019.Mar.01
A library for managing digital certificates
SoftwareAndServices::Library::iCalendar::iCalendar Class Reference

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...
 
componentgetComponent (unsigned int nTh) const
 Return the nTh component. More...
 
componentgetComponent (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...
 
iCalendargetiCal (unsigned int nTh) const
 Get the nTh ical object. More...
 
icalbodygetiCalBody (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
 
propertygetProperty (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
ExistingiCalendarObjectAn existing VCALENDER/VCALSTORE object to be added to 'this' object.

◆ iCalendar() [3/3]

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

iCalendar Constructor.

Parameters
ExistingVCalendarObjectAn 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
anotheriCalthe 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
bodyThe 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
compThe 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
propThe 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
nThnTh 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
typeToGetGet the nTh component of this type.
nThnTh 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
typeToCountOnly 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
nThnTh 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
nThnTh 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
nThnTh 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
inThe already initialized Parse() object.
errorsAn 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
inThe already opened File that contains calendar data.
errorsAn 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
inThe already initialized Parse() object.
errorsAn 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
userDataA 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
ResultsA 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: