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

Base class for all RFC-iCalendar properties. More...

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

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

Public Member Functions

 property (bool startsWtihX, const char *xname)
 property Constructor. More...
 
 property (Tokens_t type, Tokens_t ValueType=LAST_TOKEN)
 property Constructor. More...
 
 property (Tokens_t name, int Value)
 property Constructor. More...
 
 property (Tokens_t name, const text *Value)
 property Constructor. More...
 
 property (Tokens_t name, const char *Value)
 property Constructor. More...
 
 property (Tokens_t name, const binary *Value)
 property Constructor. More...
 
 property (Tokens_t name, const boolean *Value)
 property Constructor. More...
 
 property (Tokens_t name, bool Value)
 property Constructor. More...
 
 property (Tokens_t name, const uri *Value)
 property Constructor. More...
 
 property (Tokens_t name, const upn_value *Value)
 property Constructor. More...
 
 property (Tokens_t name, const upn_filter *Value)
 property Constructor. More...
 
 property (Tokens_t name, const cal_address *Value)
 property Constructor. More...
 
 property (Tokens_t name, const utc_offset *Value)
 property Constructor. More...
 
 property (Tokens_t name, const date *Value)
 property Constructor. More...
 
 property (Tokens_t name, const time *Value)
 property Constructor. More...
 
 property (Tokens_t name, const date_time *Value)
 property Constructor. More...
 
 property (Tokens_t name, const dur_value *Value)
 property Constructor. More...
 
 property (Tokens_t name, const float_value *Value)
 property Constructor. More...
 
 property (Tokens_t name, double Value)
 property Constructor. More...
 
 property (Tokens_t name, const integer *Value)
 property Constructor. More...
 
 property (Tokens_t name, const period *Value)
 property Constructor. More...
 
 property (Tokens_t name, const recur *Value)
 property Constructor. More...
 
 property (Tokens_t name, const cal_query *Value)
 property Constructor. More...
 
 property (bool startsWithX, const text *name, const text *Value)
 property Constructor. More...
 
 property (const text *xName, const text *xValue)
 property Constructor. More...
 
 property (const char *xName, const char *xValue)
 property Constructor. More...
 
 property (const property &CopyFrom)
 property - Copy Constructor. More...
 
virtual ~property ()
 property 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...
 
bool addIfNew (const parameter *)
 Add a parameter to this ones list - IF - no parameter with the same name already exists. More...
 
virtual bool addParameter (const parameter *newParam)
 Add a parameter to this ones list. More...
 
bool addX (const char *xName, char *xValue)
 Add each of the value types - VALUES. More...
 
virtual InstanceCount_t decInstance () const
 Override the default decInstance, so we can also update the instances of the property parameters. More...
 
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
 
parametergetParam (const char *name) const
 
parametergetParam (Tokens_t name) const
 
parametergetParam (unsigned int nTh) const
 Get the nTh parameter. More...
 
const parameterVecgetParams () const
 
bool getParamValue (String *Results, Tokens_t token, unsigned int nTh)
 Given a TOKEN of a parameter, return the nTh value for the parameter. More...
 
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...
 
Tokens_t getValueType () const
 
const textgetXName () const
 
virtual InstanceCount_t incInstance () const
 Override the default incInstance, so we can also update the instances of the property parameters. More...
 
void operator delete (void *data)
 We override delete so we can do smart instance counting. More...
 
bool operator!= (const value &Other) const
 value != compare operator. More...
 
bool operator!= (const value *Other) const
 value != compare operator. More...
 
bool operator!= (const property &Other) const
 property != operator More...
 
propertyoperator= (const property &CopyFrom)
 Copy the property. More...
 
bool operator== (const value &Other) const
 value == compare operator. More...
 
bool operator== (const value *Other) const
 value == compare operator. More...
 
bool operator== (const property &Other) const
 property == operator More...
 
bool parse (Parse &in, component *errors)
 Parse a property. More...
 
bool parse (const char *in, component *errors)
 Parse a property. More...
 
bool parseDateTime (Parse &in, Tokens_t DefalutValueType, component *errors)
 Parse a date_time property. More...
 
bool parseText (Parse &in, Tokens_t DefalutValueType, component *errors)
 Parse a text property. More...
 
bool parseValue (Parse &in, Tokens_t DefalutValueType, component *errors)
 Based on the VALUE (or default), parse the data and add it to the property. More...
 
bool remove (const parameter *param)
 Remove the provided parameter from this property. More...
 
bool setName (Tokens_t name)
 Set the name of the property. More...
 
Tokens_t setName (const char *name)
 Set the name of the property. More...
 
virtual bool setType (Tokens_t token, unsigned int nTh=0)
 Set the type of the nTh value. More...
 
bool setValueType (Tokens_t type)
 Set/Get value type. More...
 
bool sprint (String *TheResults, const char *Separator=NULL) const
 Print the object in RFC-iCalendar format. More...
 
bool sprint (String *Results) const
 Print the property in RFC-iCalendar format. More...
 
virtual bool validParams (const Tokens_t *validArray) const
 Passed an array of Tokens_t, terminated with UnknwonTokens_t The parameters can only contain those tokens, or returns false. More...
 

Detailed Description

Base class for all RFC-iCalendar properties.

Definition at line 79 of file property.hpp.

Constructor & Destructor Documentation

◆ property() [1/27]

SoftwareAndServices::Library::iCalendar::property::property ( bool  startsWtihX,
const char *  xname 
)

property Constructor.

Parameters
startsWithXWhen TRUE, prepend X- to xname.
xnameThe name of the property.

◆ property() [2/27]

SoftwareAndServices::Library::iCalendar::property::property ( Tokens_t  type,
Tokens_t  ValueType = LAST_TOKEN 
)

property Constructor.

Parameters
typeThe type of the property to create.
ValueTypeThe type of the value.

◆ property() [3/27]

SoftwareAndServices::Library::iCalendar::property::property ( Tokens_t  name,
int  Value 
)

property Constructor.

Parameters
nameThe name of the property to construct.
ValueThe initial value.

◆ property() [4/27]

SoftwareAndServices::Library::iCalendar::property::property ( Tokens_t  name,
const text Value 
)

property Constructor.

Parameters
nameThe name of the property to construct.
ValueThe initial value.

◆ property() [5/27]

SoftwareAndServices::Library::iCalendar::property::property ( Tokens_t  name,
const char *  Value 
)

property Constructor.

Parameters
nameThe name of the property to construct.
ValueThe initial value.

◆ property() [6/27]

SoftwareAndServices::Library::iCalendar::property::property ( Tokens_t  name,
const binary Value 
)

property Constructor.

Parameters
nameThe name of the property to construct.
ValueThe initial value.

◆ property() [7/27]

SoftwareAndServices::Library::iCalendar::property::property ( Tokens_t  name,
const boolean Value 
)

property Constructor.

Parameters
nameThe name of the property to construct.
ValueThe initial value.

◆ property() [8/27]

SoftwareAndServices::Library::iCalendar::property::property ( Tokens_t  name,
bool  Value 
)

property Constructor.

Parameters
nameThe name of the property to construct.
ValueThe initial value.

◆ property() [9/27]

SoftwareAndServices::Library::iCalendar::property::property ( Tokens_t  name,
const uri Value 
)

property Constructor.

Parameters
nameThe name of the property to construct.
ValueThe initial value.

◆ property() [10/27]

SoftwareAndServices::Library::iCalendar::property::property ( Tokens_t  name,
const upn_value Value 
)

property Constructor.

Parameters
nameThe name of the property to construct.
ValueThe initial value.

◆ property() [11/27]

SoftwareAndServices::Library::iCalendar::property::property ( Tokens_t  name,
const upn_filter Value 
)

property Constructor.

Parameters
nameThe name of the property to construct.
ValueThe initial value.

◆ property() [12/27]

SoftwareAndServices::Library::iCalendar::property::property ( Tokens_t  name,
const cal_address Value 
)

property Constructor.

Parameters
nameThe name of the property to construct.
ValueThe initial value.

◆ property() [13/27]

SoftwareAndServices::Library::iCalendar::property::property ( Tokens_t  name,
const utc_offset Value 
)

property Constructor.

Parameters
nameThe name of the property to construct.
ValueThe initial value.

◆ property() [14/27]

SoftwareAndServices::Library::iCalendar::property::property ( Tokens_t  name,
const date Value 
)

property Constructor.

Parameters
nameThe name of the property to construct.
ValueThe initial value.

◆ property() [15/27]

SoftwareAndServices::Library::iCalendar::property::property ( Tokens_t  name,
const time Value 
)

property Constructor.

Parameters
nameThe name of the property to construct.
ValueThe initial value.

◆ property() [16/27]

SoftwareAndServices::Library::iCalendar::property::property ( Tokens_t  name,
const date_time Value 
)

property Constructor.

Parameters
nameThe name of the property to construct.
ValueThe initial value.

◆ property() [17/27]

SoftwareAndServices::Library::iCalendar::property::property ( Tokens_t  name,
const dur_value Value 
)

property Constructor.

Parameters
nameThe name of the property to construct.
ValueThe initial value.

◆ property() [18/27]

SoftwareAndServices::Library::iCalendar::property::property ( Tokens_t  name,
const float_value Value 
)

property Constructor.

Parameters
nameThe name of the property to construct.
ValueThe initial value.

◆ property() [19/27]

SoftwareAndServices::Library::iCalendar::property::property ( Tokens_t  name,
double  Value 
)

property Constructor.

Parameters
nameThe name of the property to construct.
ValueThe initial value.

◆ property() [20/27]

SoftwareAndServices::Library::iCalendar::property::property ( Tokens_t  name,
const integer Value 
)

property Constructor.

Parameters
nameThe name of the property to construct.
ValueThe initial value.

◆ property() [21/27]

SoftwareAndServices::Library::iCalendar::property::property ( Tokens_t  name,
const period Value 
)

property Constructor.

Parameters
nameThe name of the property to construct.
ValueThe initial value.

◆ property() [22/27]

SoftwareAndServices::Library::iCalendar::property::property ( Tokens_t  name,
const recur Value 
)

property Constructor.

Parameters
nameThe name of the property to construct.
ValueThe initial value.

◆ property() [23/27]

SoftwareAndServices::Library::iCalendar::property::property ( Tokens_t  name,
const cal_query Value 
)

property Constructor.

Parameters
nameThe name of the property to construct.
ValueThe initial value.

◆ property() [24/27]

SoftwareAndServices::Library::iCalendar::property::property ( bool  startsWithX,
const text name,
const text Value 
)

property Constructor.

Parameters
startsWithXWhen TRUE, prepend X- to the property name.
nameThe name of the property to construct.
ValueThe initial value.

◆ property() [25/27]

SoftwareAndServices::Library::iCalendar::property::property ( const text xName,
const text xValue 
)

property Constructor.

Parameters
nameThe name of the property to construct.
ValueThe initial value.

◆ property() [26/27]

SoftwareAndServices::Library::iCalendar::property::property ( const char *  xName,
const char *  xValue 
)

property Constructor.

Parameters
nameThe name of the property to construct.
ValueThe initial value.

◆ property() [27/27]

SoftwareAndServices::Library::iCalendar::property::property ( const property CopyFrom)

property - Copy Constructor.

Parameters
CopyFromA property to copy. This makes a new copy of the property, it does not just increment the instance counter of CopyFrom.

◆ ~property()

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

property 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.

◆ addIfNew()

bool SoftwareAndServices::Library::iCalendar::property::addIfNew ( const parameter )

Add a parameter to this ones list - IF - no parameter with the same name already exists.

Parameters
newParamThe new parameter to be added.
Returns
TRUE if added.

◆ addParameter()

virtual bool SoftwareAndServices::Library::iCalendar::property::addParameter ( const parameter newParam)
virtual

Add a parameter to this ones list.

Parameters
newParamThe new parameter to be added.
Returns
TRUE if added.

◆ addX()

bool SoftwareAndServices::Library::iCalendar::property::addX ( const char *  xName,
char *  xValue 
)

Add each of the value types - VALUES.

And sets the correct value type. The will return FALSE if _type is set to something other than UNKNOWN and an add() call is made for another type. All MUST BE the same type for the same property.

Parameters
xNameThe name of the X- value type to add.
xValueThe value to add.

◆ decInstance()

virtual InstanceCount_t SoftwareAndServices::Library::iCalendar::property::decInstance ( ) const
virtual

Override the default decInstance, so we can also update the instances of the property parameters.

Returns
The current instance count for this object.

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

◆ 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< property >::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< value >::getInstance ( ) const
inlinevirtualinherited
Returns
The current instance count.

Definition at line 118 of file instance.hpp.

◆ getName()

Tokens_t SoftwareAndServices::Library::iCalendar::property::getName ( ) const
Returns
The name of the property.

◆ getParam() [1/3]

parameter* SoftwareAndServices::Library::iCalendar::property::getParam ( const char *  name) const
Parameters
nameThe name of the parameter to get.
Returns
The named parameter, or NULL if none.

◆ getParam() [2/3]

parameter* SoftwareAndServices::Library::iCalendar::property::getParam ( Tokens_t  name) const
Parameters
nameThe name of the parameter to get.
Returns
The named parameter, or NULL if none.

◆ getParam() [3/3]

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

Get the nTh parameter.

Parameters
nThWhich parameter to get (first is zero).
Returns
The nTh parameter, or NULL if none.

◆ getParams()

const parameterVec* SoftwareAndServices::Library::iCalendar::property::getParams ( ) const
Returns
The list of parameters in the property.

◆ getParamValue()

bool SoftwareAndServices::Library::iCalendar::property::getParamValue ( String Results,
Tokens_t  token,
unsigned int  nTh 
)

Given a TOKEN of a parameter, return the nTh value for the parameter.

Parameters
ResultsThis is where the value will be appended to.
tokenThe name of the parameter to fetch the value of.
nThWhich value to fetch from the parameter (first is zero).
Returns
TRUE if anything was appended.

◆ 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.

◆ getValueType()

Tokens_t SoftwareAndServices::Library::iCalendar::property::getValueType ( ) const
Returns
The value type of this property.

◆ getXName()

const text* SoftwareAndServices::Library::iCalendar::property::getXName ( ) const
Returns
The name of an x_property.

◆ incInstance()

virtual InstanceCount_t SoftwareAndServices::Library::iCalendar::property::incInstance ( ) const
virtual

Override the default incInstance, so we can also update the instances of the property parameters.

Returns
The current instance count for this object.

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

◆ operator delete()

void SoftwareAndServices::Library::iCalendar::property::operator delete ( void *  data)

We override delete so we can do smart instance counting.

Parameters
dataPointer to this kind of object to be deleted.

◆ operator!=() [1/3]

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!=() [2/3]

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!=() [3/3]

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

property != operator

Parameters
OtherThe other property to compare this one to.
Returns
TRUE when they are NOT the same parameters in any order.

◆ operator=()

property& SoftwareAndServices::Library::iCalendar::property::operator= ( const property CopyFrom)

Copy the property.

This does not increment the instance counter, it copies the property and creates a new property.

Parameters
CopyFromThe property to copy from.
Returns
Updated property.

◆ operator==() [1/3]

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==() [2/3]

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==() [3/3]

bool SoftwareAndServices::Library::iCalendar::property::operator== ( const property Other) const

property == operator

Parameters
OtherThe other property to compare this one to.
Returns
TRUE when they are the same parameters in any order.

◆ parse() [1/2]

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

Parse a property.

Parameters
inAn open Parse object.
errorsWhere errors will be stored.
Returns
TRUE when successful.

◆ parse() [2/2]

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

Parse a property.

Parameters
inA pointer to a property string.
errorsWhere errors cab be stored.
Returns
TRUE when successful.

◆ parseDateTime()

bool SoftwareAndServices::Library::iCalendar::property::parseDateTime ( Parse in,
Tokens_t  DefalutValueType,
component errors 
)

Parse a date_time property.

Parameters
inA pointer to a property string.
DefalutValueTypeThe default value type.
errorsWhere errors cab be stored.
Returns
TRUE when successful.

◆ parseText()

bool SoftwareAndServices::Library::iCalendar::property::parseText ( Parse in,
Tokens_t  DefalutValueType,
component errors 
)

Parse a text property.

Parameters
inA pointer to a property string.
DefalutValueTypeThe default value type.
errorsWhere errors cab be stored.
Returns
TRUE when successful.

◆ parseValue()

bool SoftwareAndServices::Library::iCalendar::property::parseValue ( Parse in,
Tokens_t  DefalutValueType,
component errors 
)

Based on the VALUE (or default), parse the data and add it to the property.

Parameters
inA pointer to a property string.
DefalutValueTypeThe default value type.
errorsWhere errors can be stored.
Returns
TRUE when successful.

◆ remove()

bool SoftwareAndServices::Library::iCalendar::property::remove ( const parameter param)

Remove the provided parameter from this property.

Parameters
paramThe parameter to remove.
Returns
TRUE when removed, or NULL if not in this property.

◆ setName() [1/2]

bool SoftwareAndServices::Library::iCalendar::property::setName ( Tokens_t  name)

Set the name of the property.

Parameters
nameThe name of the property.
Returns
TRUE when set, and matching any values.

◆ setName() [2/2]

Tokens_t SoftwareAndServices::Library::iCalendar::property::setName ( const char *  name)

Set the name of the property.

Parameters
nameThe name of the property.
Returns
TRUE when set, and matching any values.

◆ 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.

◆ setValueType()

bool SoftwareAndServices::Library::iCalendar::property::setValueType ( Tokens_t  type)

Set/Get value type.

NOTE - this MUST agree with the VALUE= parameter if it is present.

Parameters
typeThe type of value to set this property to.
Returns
TRUE when it is set and matches the value types.

◆ sprint() [1/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.

◆ sprint() [2/2]

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

Print the property in RFC-iCalendar format.

Parameters
ResultsAppend the results to Results.
Returns
TRUE when data was appended.

◆ validParams()

virtual bool SoftwareAndServices::Library::iCalendar::property::validParams ( const Tokens_t *  validArray) const
virtual

Passed an array of Tokens_t, terminated with UnknwonTokens_t The parameters can only contain those tokens, or returns false.

XPARAM may be included to allow ANY XPARAM.

Parameters
validArrayList of valid tokens (parameters) for this property.
Returns
TRUE when everything is okay.

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