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

An RFC-iCalendar implementation of a PERIOD parameter. More...

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

+ Inheritance diagram for SoftwareAndServices::Library::iCalendar::period_parameter:
+ Collaboration diagram for SoftwareAndServices::Library::iCalendar::period_parameter:

Public Member Functions

 period_parameter (Tokens_t type, const period *Value=NULL)
 period_parameter Constructor. More...
 
virtual ~period_parameter ()
 period_parameter Destructor. More...
 
virtual bool add (const BaseValueType *data)
 Many RFC-iCalendar object may contain zero or more values. More...
 
virtual bool add (const value *Value)
 Many RFC-iCalendar object may contain zero or more values. More...
 
virtual bool add (const boolean *Value)
 Many RFC-iCalendar object may contain zero or more values. More...
 
virtual bool add (const binary *Value)
 Many RFC-iCalendar object may contain zero or more values. More...
 
virtual bool add (const text *Value)
 Many RFC-iCalendar object may contain zero or more values. More...
 
virtual bool add (const uri *Value)
 Many RFC-iCalendar object may contain zero or more values. More...
 
virtual bool add (const Uri *Value)
 Many RFC-iCalendar object may contain zero or more values. More...
 
virtual bool add (const cal_address *Value)
 Many RFC-iCalendar object may contain zero or more values. More...
 
virtual bool add (const utc_offset *Value)
 Many RFC-iCalendar object may contain zero or more values. More...
 
virtual bool add (const date *Value)
 Many RFC-iCalendar object may contain zero or more values. More...
 
virtual bool add (const time *Value)
 Many RFC-iCalendar object may contain zero or more values. More...
 
virtual bool add (const date_time *Value)
 Many RFC-iCalendar object may contain zero or more values. More...
 
virtual bool add (const dur_value *Value)
 Many RFC-iCalendar object may contain zero or more values. More...
 
virtual bool add (const float_value *Value)
 Many RFC-iCalendar object may contain zero or more values. More...
 
virtual bool add (const integer *Value)
 Many RFC-iCalendar object may contain zero or more values. More...
 
virtual bool add (const period *Value)
 Many RFC-iCalendar object may contain zero or more values. More...
 
virtual bool add (const recur *Value)
 Many RFC-iCalendar object may contain zero or more values. More...
 
virtual bool add (const cal_query *Value)
 Many RFC-iCalendar object may contain zero or more values. More...
 
virtual bool add (const char *Value)
 Many RFC-iCalendar object may contain zero or more values. More...
 
virtual bool add (const upn_value *Value)
 Many RFC-iCalendar object may contain zero or more values. More...
 
virtual bool add (const upn_filter *Value)
 Many RFC-iCalendar object may contain zero or more values. More...
 
virtual bool add (Tokens_t Value)
 Many RFC-iCalendar object may contain zero or more values. More...
 
virtual bool add (const TokenValue *Value)
 Many RFC-iCalendar object may contain zero or more values. More...
 
virtual bool add (iCalError *anError) const
 Add an error to this object. More...
 
virtual InstanceCount_t decInstance () const
 Decrement the instance. More...
 
InstanceCount_t decInstance () const
 This class uses instance counting, this entry point simply bumps up the counter. More...
 
const periodget (unsigned int nTh=0) const
 Get the nTh period value from this parameter. More...
 
time_t getDuration (unsigned int offset=0) const
 Get the nTh interval time value from this parameter in seconds. More...
 
time_t getDuration (const date_time *start, const date_time *end, unsigned int offset=0)
 Get the number of seconds between to date_time values. More...
 
date_timegetEnd () const
 
virtual iCalErrorVec * getErrorList () const
 Return the error list, may be NULL or empty if no errors. More...
 
virtual InstanceCount_t getInstance () const
 
virtual InstanceCount_t getInstance () const
 
Tokens_t getName () const
 
date_timegetStart () const
 
virtual Tokens_t getType (unsigned int nTh=0) const
 Get the type of data stored. More...
 
virtual const valuegetValue (unsigned int nTh=0) const
 Get the nTh value. More...
 
virtual size_t getValueCount () const
 Get the number of values stored. More...
 
const textgetXName () const
 
virtual InstanceCount_t incInstance () const
 Increment the instance. More...
 
InstanceCount_t incInstance () const
 This class uses instance counting, this entry point simply bumps up the counter. More...
 
void operator delete (void *data)
 Override the delete operator such that it is only really deleted when the instance counter reaches zero. More...
 
bool operator!= (const parameter &Other) const
 parameter != operator More...
 
bool operator!= (const parameter *Other) const
 parameter != operator More...
 
bool operator!= (const value &Other) const
 value != compare operator. More...
 
bool operator!= (const value *Other) const
 value != compare operator. More...
 
bool operator== (const parameter &Other) const
 parameter == operator More...
 
bool operator== (const parameter *Other) const
 parameter == operator More...
 
bool operator== (const value &Other) const
 value == compare operator. More...
 
bool operator== (const value *Other) const
 value == compare operator. More...
 
virtual bool parse (Parse &in, component *errors)
 #Parse a parameter. More...
 
virtual bool parse (const char *in, component *errors)
 #Parse a parameter. More...
 
bool setName (Tokens_t type)
 Set the name of this parameter. More...
 
Tokens_t setName (const char *newName)
 Set the name of this parameter. More...
 
virtual bool setType (Tokens_t token, unsigned int nTh=0)
 Set the type of the nTh value. More...
 
virtual bool sprint (String *Results) const
 
bool sprint (String *TheResults, const char *Separator=NULL) const
 Print the object in RFC-iCalendar format. More...
 
virtual bool valid () const
 

Static Public Member Functions

static size_t decodeValue (Parse &in, String &str)
 Quote out any quotes as needed. More...
 
static size_t encodeValue (const char *in, String &str)
 Quote any quotes as needed. More...
 

Static Public Attributes

static const char * param_term_s
 What characters terminate a parameter. More...
 

Detailed Description

An RFC-iCalendar implementation of a PERIOD parameter.

Definition at line 81 of file period_parameter.hpp.

Constructor & Destructor Documentation

◆ period_parameter()

SoftwareAndServices::Library::iCalendar::period_parameter::period_parameter ( Tokens_t  type,
const period Value = NULL 
)

period_parameter Constructor.

Parameters
typeThe type of period_parameter to construct.
ValueThe initial value.

◆ ~period_parameter()

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

period_parameter Destructor.

Member Function Documentation

◆ add() [1/24]

virtual bool SoftwareAndServices::Library::iCalendar::value::add ( const BaseValueType data)
virtualinherited

Many RFC-iCalendar object may contain zero or more values.

The add() methods below add a new value to this object.

Only one 'type' of data may be added. Multiple of the same 'type' may be added. As in you can add multiple 'uri' values, however you can not add a 'uri' and a 'cal_query' to the same object (in most cases there are some special value types).

Parameters
dataThe data to add.
Returns
TRUE if successful.

◆ add() [2/24]

virtual bool SoftwareAndServices::Library::iCalendar::value::add ( const value Value)
virtualinherited

Many RFC-iCalendar object may contain zero or more values.

The add() methods below add a new value to this object.

Only one 'type' of data may be added. Multiple of the same 'type' may be added. As in you can add multiple 'uri' values, however you can not add a 'uri' and a 'cal_query' to the same object (in most cases there are some special value types).

Parameters
ValueThe data to add.
Returns
TRUE if successful.

◆ add() [3/24]

virtual bool SoftwareAndServices::Library::iCalendar::value::add ( const boolean Value)
virtualinherited

Many RFC-iCalendar object may contain zero or more values.

The add() methods below add a new value to this object.

Only one 'type' of data may be added. Multiple of the same 'type' may be added. As in you can add multiple 'uri' values, however you can not add a 'uri' and a 'cal_query' to the same object (in most cases there are some special value types).

Parameters
ValueThe data to add.
Returns
TRUE if successful.

◆ add() [4/24]

virtual bool SoftwareAndServices::Library::iCalendar::value::add ( const binary Value)
virtualinherited

Many RFC-iCalendar object may contain zero or more values.

The add() methods below add a new value to this object.

Only one 'type' of data may be added. Multiple of the same 'type' may be added. As in you can add multiple 'uri' values, however you can not add a 'uri' and a 'cal_query' to the same object (in most cases there are some special value types).

Parameters
ValueThe data to add.
Returns
TRUE if successful.

◆ add() [5/24]

virtual bool SoftwareAndServices::Library::iCalendar::value::add ( const text Value)
virtualinherited

Many RFC-iCalendar object may contain zero or more values.

The add() methods below add a new value to this object.

Only one 'type' of data may be added. Multiple of the same 'type' may be added. As in you can add multiple 'uri' values, however you can not add a 'uri' and a 'cal_query' to the same object (in most cases there are some special value types).

Parameters
ValueThe data to add.
Returns
TRUE if successful.

◆ add() [6/24]

virtual bool SoftwareAndServices::Library::iCalendar::value::add ( const uri Value)
virtualinherited

Many RFC-iCalendar object may contain zero or more values.

The add() methods below add a new value to this object.

Only one 'type' of data may be added. Multiple of the same 'type' may be added. As in you can add multiple 'uri' values, however you can not add a 'uri' and a 'cal_query' to the same object (in most cases there are some special value types).

Parameters
ValueThe data to add.
Returns
TRUE if successful.

◆ add() [7/24]

virtual bool SoftwareAndServices::Library::iCalendar::value::add ( const Uri Value)
virtualinherited

Many RFC-iCalendar object may contain zero or more values.

The add() methods below add a new value to this object.

Only one 'type' of data may be added. Multiple of the same 'type' may be added. As in you can add multiple 'uri' values, however you can not add a 'uri' and a 'cal_query' to the same object (in most cases there are some special value types).

Parameters
ValueThe data to add.
Returns
TRUE if successful.

◆ add() [8/24]

virtual bool SoftwareAndServices::Library::iCalendar::value::add ( const cal_address Value)
virtualinherited

Many RFC-iCalendar object may contain zero or more values.

The add() methods below add a new value to this object.

Only one 'type' of data may be added. Multiple of the same 'type' may be added. As in you can add multiple 'uri' values, however you can not add a 'uri' and a 'cal_query' to the same object (in most cases there are some special value types).

Parameters
ValueThe data to add.
Returns
TRUE if successful.

◆ add() [9/24]

virtual bool SoftwareAndServices::Library::iCalendar::value::add ( const utc_offset Value)
virtualinherited

Many RFC-iCalendar object may contain zero or more values.

The add() methods below add a new value to this object.

Only one 'type' of data may be added. Multiple of the same 'type' may be added. As in you can add multiple 'uri' values, however you can not add a 'uri' and a 'cal_query' to the same object (in most cases there are some special value types).

Parameters
ValueThe data to add.
Returns
TRUE if successful.

◆ add() [10/24]

virtual bool SoftwareAndServices::Library::iCalendar::value::add ( const date Value)
virtualinherited

Many RFC-iCalendar object may contain zero or more values.

The add() methods below add a new value to this object.

Only one 'type' of data may be added. Multiple of the same 'type' may be added. As in you can add multiple 'uri' values, however you can not add a 'uri' and a 'cal_query' to the same object (in most cases there are some special value types).

Parameters
ValueThe data to add.
Returns
TRUE if successful.

◆ add() [11/24]

virtual bool SoftwareAndServices::Library::iCalendar::value::add ( const time Value)
virtualinherited

Many RFC-iCalendar object may contain zero or more values.

The add() methods below add a new value to this object.

Only one 'type' of data may be added. Multiple of the same 'type' may be added. As in you can add multiple 'uri' values, however you can not add a 'uri' and a 'cal_query' to the same object (in most cases there are some special value types).

Parameters
ValueThe data to add.
Returns
TRUE if successful.

◆ add() [12/24]

virtual bool SoftwareAndServices::Library::iCalendar::value::add ( const date_time Value)
virtualinherited

Many RFC-iCalendar object may contain zero or more values.

The add() methods below add a new value to this object.

Only one 'type' of data may be added. Multiple of the same 'type' may be added. As in you can add multiple 'uri' values, however you can not add a 'uri' and a 'cal_query' to the same object (in most cases there are some special value types).

Parameters
ValueThe data to add.
Returns
TRUE if successful.

◆ add() [13/24]

virtual bool SoftwareAndServices::Library::iCalendar::value::add ( const dur_value Value)
virtualinherited

Many RFC-iCalendar object may contain zero or more values.

The add() methods below add a new value to this object.

Only one 'type' of data may be added. Multiple of the same 'type' may be added. As in you can add multiple 'uri' values, however you can not add a 'uri' and a 'cal_query' to the same object (in most cases there are some special value types).

Parameters
ValueThe data to add.
Returns
TRUE if successful.

◆ add() [14/24]

virtual bool SoftwareAndServices::Library::iCalendar::value::add ( const float_value Value)
virtualinherited

Many RFC-iCalendar object may contain zero or more values.

The add() methods below add a new value to this object.

Only one 'type' of data may be added. Multiple of the same 'type' may be added. As in you can add multiple 'uri' values, however you can not add a 'uri' and a 'cal_query' to the same object (in most cases there are some special value types).

Parameters
ValueThe data to add.
Returns
TRUE if successful.

◆ add() [15/24]

virtual bool SoftwareAndServices::Library::iCalendar::value::add ( const integer Value)
virtualinherited

Many RFC-iCalendar object may contain zero or more values.

The add() methods below add a new value to this object.

Only one 'type' of data may be added. Multiple of the same 'type' may be added. As in you can add multiple 'uri' values, however you can not add a 'uri' and a 'cal_query' to the same object (in most cases there are some special value types).

Parameters
ValueThe data to add.
Returns
TRUE if successful.

◆ add() [16/24]

virtual bool SoftwareAndServices::Library::iCalendar::value::add ( const period Value)
virtualinherited

Many RFC-iCalendar object may contain zero or more values.

The add() methods below add a new value to this object.

Only one 'type' of data may be added. Multiple of the same 'type' may be added. As in you can add multiple 'uri' values, however you can not add a 'uri' and a 'cal_query' to the same object (in most cases there are some special value types).

Parameters
ValueThe data to add.
Returns
TRUE if successful.

◆ add() [17/24]

virtual bool SoftwareAndServices::Library::iCalendar::value::add ( const recur Value)
virtualinherited

Many RFC-iCalendar object may contain zero or more values.

The add() methods below add a new value to this object.

Only one 'type' of data may be added. Multiple of the same 'type' may be added. As in you can add multiple 'uri' values, however you can not add a 'uri' and a 'cal_query' to the same object (in most cases there are some special value types).

Parameters
ValueThe data to add.
Returns
TRUE if successful.

◆ add() [18/24]

virtual bool SoftwareAndServices::Library::iCalendar::value::add ( const cal_query Value)
virtualinherited

Many RFC-iCalendar object may contain zero or more values.

The add() methods below add a new value to this object.

Only one 'type' of data may be added. Multiple of the same 'type' may be added. As in you can add multiple 'uri' values, however you can not add a 'uri' and a 'cal_query' to the same object (in most cases there are some special value types).

Parameters
ValueThe data to add.
Returns
TRUE if successful.

◆ add() [19/24]

virtual bool SoftwareAndServices::Library::iCalendar::value::add ( const char *  Value)
virtualinherited

Many RFC-iCalendar object may contain zero or more values.

The add() methods below add a new value to this object.

Only one 'type' of data may be added. Multiple of the same 'type' may be added. As in you can add multiple 'uri' values, however you can not add a 'uri' and a 'cal_query' to the same object (in most cases there are some special value types).

Parameters
ValueThe data to add.
Returns
TRUE if successful.

◆ add() [20/24]

virtual bool SoftwareAndServices::Library::iCalendar::value::add ( const upn_value Value)
virtualinherited

Many RFC-iCalendar object may contain zero or more values.

The add() methods below add a new value to this object.

Only one 'type' of data may be added. Multiple of the same 'type' may be added. As in you can add multiple 'uri' values, however you can not add a 'uri' and a 'cal_query' to the same object (in most cases there are some special value types).

Parameters
ValueThe data to add.

◆ add() [21/24]

virtual bool SoftwareAndServices::Library::iCalendar::value::add ( const upn_filter Value)
virtualinherited

Many RFC-iCalendar object may contain zero or more values.

The add() methods below add a new value to this object.

Only one 'type' of data may be added. Multiple of the same 'type' may be added. As in you can add multiple 'uri' values, however you can not add a 'uri' and a 'cal_query' to the same object (in most cases there are some special value types).

Parameters
ValueThe data to add.
Returns
TRUE if successful.

◆ add() [22/24]

virtual bool SoftwareAndServices::Library::iCalendar::value::add ( Tokens_t  Value)
virtualinherited

Many RFC-iCalendar object may contain zero or more values.

The add() methods below add a new value to this object.

Only one 'type' of data may be added. Multiple of the same 'type' may be added. As in you can add multiple 'uri' values, however you can not add a 'uri' and a 'cal_query' to the same object (in most cases there are some special value types).

Parameters
ValueThe data to add.
Returns
TRUE if successful.

◆ add() [23/24]

virtual bool SoftwareAndServices::Library::iCalendar::value::add ( const TokenValue Value)
virtualinherited

Many RFC-iCalendar object may contain zero or more values.

The add() methods below add a new value to this object.

Only one 'type' of data may be added. Multiple of the same 'type' may be added. As in you can add multiple 'uri' values, however you can not add a 'uri' and a 'cal_query' to the same object (in most cases there are some special value types).

Parameters
ValueThe data to add.
Returns
TRUE if successful.

◆ add() [24/24]

virtual bool SoftwareAndServices::Library::iCalendar::value::add ( iCalError anError) const
virtualinherited

Add an error to this object.

Parameters
anErroThe error to add.
Returns
TRUE if successful.

◆ decInstance() [1/2]

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

Decrement the instance.

Returns
The instance count, after decrementing it.

Definition at line 129 of file instance.hpp.

◆ decInstance() [2/2]

InstanceCount_t SoftwareAndServices::Library::iCalendar::value::decInstance ( ) const
virtualinherited

This class uses instance counting, this entry point simply bumps up the counter.

Returns
The current instance count.

Reimplemented from SoftwareAndServices::Library::Common::instance< value >.

◆ decodeValue()

static size_t SoftwareAndServices::Library::iCalendar::parameter::decodeValue ( Parse in,
String str 
)
staticinherited

Quote out any quotes as needed.

Returns
The new size of the string.

◆ encodeValue()

static size_t SoftwareAndServices::Library::iCalendar::parameter::encodeValue ( const char *  in,
String str 
)
staticinherited

Quote any quotes as needed.

Returns
The new size of the string.

◆ get()

const period* SoftwareAndServices::Library::iCalendar::period_parameter::get ( unsigned int  nTh = 0) const

Get the nTh period value from this parameter.

Parameters
nThWhich period value to get (first is zero).
ThenThe value or NULL if it does not exist.

◆ getDuration() [1/2]

time_t SoftwareAndServices::Library::iCalendar::period_parameter::getDuration ( unsigned int  offset = 0) const

Get the nTh interval time value from this parameter in seconds.

Parameters
nThWhich period value to get (first is zero).
ThenThe interval time value or NULL if it does not exist.

◆ getDuration() [2/2]

time_t SoftwareAndServices::Library::iCalendar::period_parameter::getDuration ( const date_time start,
const date_time end,
unsigned int  offset = 0 
)

Get the number of seconds between to date_time values.

Parameters
startThe start date_time.
endThe end date_time.
nThWhich offset to get in a multiple set of durations.
Returns
The number of seconds.

◆ getEnd()

date_time* SoftwareAndServices::Library::iCalendar::period_parameter::getEnd ( ) const
Returns
Get or calculate the end date_time of this period.

◆ getErrorList()

virtual iCalErrorVec* SoftwareAndServices::Library::iCalendar::value::getErrorList ( ) const
virtualinherited

Return the error list, may be NULL or empty if no errors.

Returns
NULL or a pointer to any errors (list may be empty).

◆ getInstance() [1/2]

virtual InstanceCount_t SoftwareAndServices::Library::Common::instance< value >::getInstance ( ) const
inlinevirtualinherited
Returns
The current instance count.

Definition at line 118 of file instance.hpp.

◆ getInstance() [2/2]

virtual InstanceCount_t SoftwareAndServices::Library::Common::instance< parameter >::getInstance ( ) const
inlinevirtualinherited
Returns
The current instance count.

Definition at line 118 of file instance.hpp.

◆ getName()

Tokens_t SoftwareAndServices::Library::iCalendar::parameter::getName ( ) const
inherited
Returns
The name of this parameter.

◆ getStart()

date_time* SoftwareAndServices::Library::iCalendar::period_parameter::getStart ( ) const
Returns
Get the start date_time for this period.

◆ getType()

virtual Tokens_t SoftwareAndServices::Library::iCalendar::value::getType ( unsigned int  nTh = 0) const
virtualinherited

Get the type of data stored.

Parameters
nThThis starts from zero, get the type of the nTh value.
Returns
The type of data stored.

◆ getValue()

virtual const value* SoftwareAndServices::Library::iCalendar::value::getValue ( unsigned int  nTh = 0) const
virtualinherited

Get the nTh value.

Parameters
nThThe nTh value to get (start from zero)
Returns
A pointer to the data.

◆ getValueCount()

virtual size_t SoftwareAndServices::Library::iCalendar::value::getValueCount ( ) const
virtualinherited

Get the number of values stored.

Returns
The number of values stored.

◆ getXName()

const text* SoftwareAndServices::Library::iCalendar::parameter::getXName ( ) const
inherited
Returns
The name of this non-standard parameter.

◆ incInstance() [1/2]

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

Increment the instance.

Returns
The instance value, after incrementing it.

Definition at line 109 of file instance.hpp.

◆ incInstance() [2/2]

InstanceCount_t SoftwareAndServices::Library::iCalendar::value::incInstance ( ) const
virtualinherited

This class uses instance counting, this entry point simply bumps up the counter.

Returns
The current instance count.

Reimplemented from SoftwareAndServices::Library::Common::instance< value >.

◆ operator delete()

void SoftwareAndServices::Library::iCalendar::parameter::operator delete ( void *  data)
inherited

Override the delete operator such that it is only really deleted when the instance counter reaches zero.

Parameters
dataWhat to delete.

◆ operator!=() [1/4]

bool SoftwareAndServices::Library::iCalendar::parameter::operator!= ( const parameter Other) const
inherited

parameter != operator

Parameters
OtherThe other parameter to compare this one to.
Returns
TRUE when they are NOT the same values in the same order.

◆ operator!=() [2/4]

bool SoftwareAndServices::Library::iCalendar::parameter::operator!= ( const parameter Other) const
inherited

parameter != operator

Parameters
OtherThe other parameter to compare this one to.
Returns
TRUE when they are NOT the same values in the same order.

◆ operator!=() [3/4]

bool SoftwareAndServices::Library::iCalendar::value::operator!= ( const value Other) const
inherited

value != compare operator.

Parameters
OtherThe other value to compare to.
Returns
TRUE when they are NOT equal (OR do not have the same number of values in the same order).

◆ operator!=() [4/4]

bool SoftwareAndServices::Library::iCalendar::value::operator!= ( const value Other) const
inherited

value != compare operator.

Parameters
OtherThe other value to compare to.
Returns
TRUE when they are NOT equal (OR do not have the same number of values in the same order).

◆ operator==() [1/4]

bool SoftwareAndServices::Library::iCalendar::parameter::operator== ( const parameter Other) const
inherited

parameter == operator

Parameters
OtherThe other parameter to compare this one to.
Returns
TRUE when they are the same values in the same order.

◆ operator==() [2/4]

bool SoftwareAndServices::Library::iCalendar::parameter::operator== ( const parameter Other) const
inherited

parameter == operator

Parameters
OtherThe other parameter to compare this one to.
Returns
TRUE when they are the same values in the same order.

◆ operator==() [3/4]

bool SoftwareAndServices::Library::iCalendar::value::operator== ( const value Other) const
inherited

value == compare operator.

Parameters
OtherThe other value to compare to.
Returns
TRUE when they are equal (and the same number of values in the same order).

◆ operator==() [4/4]

bool SoftwareAndServices::Library::iCalendar::value::operator== ( const value Other) const
inherited

value == compare operator.

Parameters
OtherThe other value to compare to.
Returns
TRUE when they are equal (and the same number of values in the same order).

◆ parse() [1/2]

virtual bool SoftwareAndServices::Library::iCalendar::parameter::parse ( Parse in,
component errors 
)
virtualinherited

#Parse a parameter.

Parameters
inAn open Parse object.
errorsWhere to put any errors.
Returns
TRUE if parsed successfully.

◆ parse() [2/2]

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

#Parse a parameter.

Parameters
inA pointer to a string representation of a parameter.
errorsWhere to put any errors.
Returns
TRUE if parsed successfully.

◆ setName() [1/2]

bool SoftwareAndServices::Library::iCalendar::parameter::setName ( Tokens_t  type)
inherited

Set the name of this parameter.

Parameters
typeThe type (name) of this parameter.
Returns
TRUE when set and any values are of the correct type.

◆ setName() [2/2]

Tokens_t SoftwareAndServices::Library::iCalendar::parameter::setName ( const char *  newName)
inherited

Set the name of this parameter.

Parameters
newNameThe new name of this parameter.
Returns
The name ID for this parameter.

◆ setType()

virtual bool SoftwareAndServices::Library::iCalendar::value::setType ( Tokens_t  token,
unsigned int  nTh = 0 
)
virtualinherited

Set the type of the nTh value.

Parameters
tokenThe type of data to be set.
nThThe nTh (starts from zero) value type to be set.
Returns
TRUE if set.

◆ sprint() [1/2]

virtual bool SoftwareAndServices::Library::iCalendar::parameter::sprint ( String Results) const
virtualinherited
Parameters
ResultsA C-String RFC-ICalendar representation of this parameter.
Returns
TRUE when something appended to Results.

◆ sprint() [2/2]

bool SoftwareAndServices::Library::iCalendar::value::sprint ( String TheResults,
const char *  Separator = NULL 
) const
inherited

Print the object in RFC-iCalendar format.

Parameters
TheResultsAppend the string to this string.
SeparatorIf not-NULL, separate the values with this string.
Returns
TRUE if anything is appended.

◆ valid()

Member Data Documentation

◆ param_term_s

const char* SoftwareAndServices::Library::iCalendar::parameter::param_term_s
staticinherited

What characters terminate a parameter.

Definition at line 225 of file parameter.hpp.


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