cUPnPClassItem Class Reference

#include <object.h>

Inheritance diagram for cUPnPClassItem:

[legend]

Collaboration diagram for cUPnPClassItem:

[legend]

List of all members.

Public Member Functions
virtual cStringList *	getPropertyList ()
virtual IXML_Node *	createDIDLFragment (IXML_Document *Document, cStringList *Filter)
virtual bool	setProperty (const char *Property, const char *Value)
virtual bool	getProperty (const char *Property, char **Value) const
int	setReference (cUPnPClassItem *Reference)
cUPnPClassItem *	getReference () const
cUPnPObjectID	getReferenceID () const
Protected Member Functions
	cUPnPClassItem ()
Protected Attributes
cUPnPClassItem *	mReference
	The reference item.
Friends
class	cMediaDatabase
class	cUPnPObjectMediator
class	cUPnPItemMediator

---

Detailed Description

The UPnP class Item

This is a UPnP class Item representation with all its properties.

---

Constructor & Destructor Documentation

cUPnPClassItem::cUPnPClassItem

(

)

[protected]

Constructor of an item

This creates a new instance of an item

---

Member Function Documentation

IXML_Node * cUPnPClassItem::createDIDLFragment	(	IXML_Document *	Document,
		cStringList *	Filter
	)			[virtual]

Create the DIDL fragment

This creates the DIDL-Lite fragment of the object. The DIDL is written to the specified IXML document. The details of the output can be controlled via the filter stringlist

Returns:

the DIDL fragment of the object

Parameters:

	Document	the IXML document where to write the contents
	Filter	the string list with the filter criteria

Implements cUPnPClassObject.

bool cUPnPClassItem::getProperty	(	const char *	Property,
		char **	Value
	)			const [virtual]

Gets a property

Returns the value of a specified property. The value is converted into a string.

Returns:

returns

• true, if the property exists
• false, otherwise

Parameters:

	Property	the property which should be returned
	Value	the value of that property

Reimplemented from cUPnPClassObject.

Reimplemented in cUPnPClassVideoItem, cUPnPClassMovie, and cUPnPClassVideoBroadcast.

cStringList * cUPnPClassItem::getPropertyList

(

)

[virtual]

Get the properties of the object

This returns a property list with all the properties which can be obtained or set with getProperty or setProperty.

Returns:

a stringlist with the properties

Reimplemented from cUPnPClassObject.

Reimplemented in cUPnPClassVideoItem, cUPnPClassMovie, and cUPnPClassVideoBroadcast.

cUPnPClassItem* cUPnPClassItem::getReference

(

)

const [inline]

Get the referenced item

This returns the referenced item of this item

Returns:

the referenced item

cUPnPObjectID cUPnPClassItem::getReferenceID

(

)

const [inline]

Get the reference ID

This returns the object ID of the referenced item or -1, if no reference exists.

Returns:

the reference ID

bool cUPnPClassItem::setProperty	(	const char *	Property,
		const char *	Value
	)			[virtual]

Sets a property

Sets the value of a specified property. The value is converted from string into the propper data type

Returns:

returns

• true, if the property exists
• false, otherwise

Parameters:

	Property	the property which should be set
	Value	the value of that property

Reimplemented from cUPnPClassObject.

Reimplemented in cUPnPClassVideoItem, cUPnPClassMovie, and cUPnPClassVideoBroadcast.

int cUPnPClassItem::setReference

(

cUPnPClassItem *

Reference

)

Set a reference item

This sets a reference item. Its comparable with symlinks in *nix systems

Returns:

returns

• 0, if setting was successful
• <0, otherwise

Parameters:

Reference

the reference item

---

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

• database/object.h
• database/object.cpp