pfs::TagContainer Class Reference

TagContainer interface allows to read and modify tags. More...

#include <pfs.h>

List of all members.

Public Member Functions
virtual const char *	getString (const char *tagName)=0
	Get a string tag of the name tagName from the TagContainer.
virtual void	setString (const char *tagName, const char *tagValue)=0
	Set or add a string tag of the name tagName.
virtual void	removeTag (const char *tagName)=0
	Removes (if exists) a tag of the name tagName from the TagContainer.
virtual TagIteratorPtr	getIterator () const =0
	Use TagIterator to iterate over all tags in the TagContainer.

---

Detailed Description

TagContainer interface allows to read and modify tags.

A tag is "name"="value" pair.

Definition at line 135 of file pfs.h.

---

Member Function Documentation

virtual const char* pfs::TagContainer::getString

(

const char *

tagName

)

[pure virtual]

Get a string tag of the name tagName from the TagContainer.

Parameters:

tagName

name of the tag to retrieve

Returns:

tag value or NULL if tag was not found

virtual void pfs::TagContainer::setString	(	const char *	tagName,
		const char *	tagValue
	)			[pure virtual]

Set or add a string tag of the name tagName.

Parameters:

	tagName	name of the tag to add or set
	tagValue	value of the tag

virtual void pfs::TagContainer::removeTag

(

const char *

tagName

)

[pure virtual]

Removes (if exists) a tag of the name tagName from the TagContainer.

Parameters:

tagName

name of the tag to remove

virtual TagIteratorPtr pfs::TagContainer::getIterator

(

)

const [pure virtual]

Use TagIterator to iterate over all tags in the TagContainer.

TagIteratorPtr is a smart pointer, which destructs TagIterator when TagIteratorPtr is destructed. Use -> operator to access TagIterator members from a TagIteratorPtr object.

To iterate over all tags, use the following code: pfs::TagIteratorPtr it( frame->getTags()->getIterator() ); while( it->hasNext() ) { const char *tagName = it->getNext(); //Do something }

---

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

• pfs.h

---