prt::AttributeMapBuilder Class Reference

#include <AttributeMap.h>

Inheritance diagram for prt::AttributeMapBuilder:

Public Member Functions
virtual AttributeMap const *	createAttributeMap (Status *status=0) const =0
virtual AttributeMap const *	createAttributeMapAndReset (Status *status=0)=0
virtual void	resetToAttributeMap (const AttributeMap *src, Status *status=0)=0
virtual void	updateWithAttributeMap (const AttributeMap *src, bool force=false, Status *status=0)=0
Public Member Functions inherited from prt::AttributableSetter
virtual Status	setBool (const wchar_t *key, bool value)=0
virtual Status	setBoolArray (const wchar_t *key, const bool *value, size_t count)=0
virtual Status	setFloat (const wchar_t *key, double value)=0
virtual Status	setFloatArray (const wchar_t *key, const double *value, size_t count)=0
virtual Status	setInt (const wchar_t *key, int32_t value)=0
virtual Status	setIntArray (const wchar_t *key, const int32_t *value, size_t count)=0
virtual Status	setString (const wchar_t *key, const wchar_t *value)=0
virtual Status	setStringArray (const wchar_t *key, const wchar_t *const *value, size_t count)=0
Public Member Functions inherited from prt::Object
void	destroy () const
virtual char *	toXML (char *result, size_t *resultSize, Status *stat=0) const =0
char *	toXMLDocument (char *result, size_t *resultSize, Status *stat=0) const

Static Public Member Functions
static AttributeMapBuilder *	create (Status *status=0)
static AttributeMapBuilder *	createFromAttributeMap (const AttributeMap *src, Status *status=0)

Additional Inherited Members
Protected Member Functions inherited from prt::Object
	Object (const Object &)

Detailed Description

A builder to create AttributeMap instances.

Member Function Documentation

create()

static AttributeMapBuilder* prt::AttributeMapBuilder::create ( Status *  status = 0 )

static

Creates a new AttributeMapBuilder instance.

Parameters

[out]

status

Optional pointer to return the status.

Returns

Pointer to a new instance of an AttributeMapBuilder on success or 0 on failure.

createAttributeMap()

virtual AttributeMap const* prt::AttributeMapBuilder::createAttributeMap ( Status *  status = 0 ) const

pure virtual

Creates a new AttributeInstance which contains all currently set key-value pairs. The AttributeBuilder's state is preserved.

Parameters

[out]

status

Optional pointer to return the status.

Returns

Pointer to a new instance of an AttributeMap on success or 0 on failure.

createAttributeMapAndReset()

virtual AttributeMap const* prt::AttributeMapBuilder::createAttributeMapAndReset ( Status *  status = 0 )

pure virtual

Creates a new AttributeInstance which contains all currently set key-value pairs. The AttributeBuilder is reset to its initial state.

Parameters

[out]

status

Optional pointer to return the status.

Returns

Pointer to a new instance of an AttributeMap on success or 0 on failure.

createFromAttributeMap()

static AttributeMapBuilder* prt::AttributeMapBuilder::createFromAttributeMap ( const AttributeMap *  src, Status *  status = 0  )

static

Creates a new AttributeMapBuilder instance initialized to the content of a AttributeMap.

Parameters

[in]	src	Source AttributeMap. The new instance wil be initialized to the values of src.
[out]	status	Optional pointer to return the status.

Returns

Pointer to a new instance of an AttributeMapBuilder on success or 0 on failure.

resetToAttributeMap()

virtual void prt::AttributeMapBuilder::resetToAttributeMap ( const AttributeMap *  src, Status *  status = 0  )

pure virtual

Resets the AttributeMapBuilder to the content of the passed AttributeMap.

Parameters

[in]	src	Source AttributeMap. The new instance wil be initialized to the values of src.
[out]	status	Optional pointer to return the status.

updateWithAttributeMap()

virtual void prt::AttributeMapBuilder::updateWithAttributeMap ( const AttributeMap *  src, bool  force = false, Status *  status = 0  )

pure virtual

Adds the content of src to the current builder state. Conflict resolution is as follows:

• If key and type of the incoming item match with an existing item the content will be overwritten.
• If the key matches but not the type, the content will only be overwritten if force equals true.

Parameters

[in]	src	Source AttributeMap. Its content will be added to the builder.
[in]	force	Conflict resolution control flag used in case of type mismatch.
[out]	status	Optional pointer to return the status.

---

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

• AttributeMap.h