Siena Fast Forwarding Documentation (v. 2.0.1)
Classes | Public Member Functions | List of all members
siena::TagSet Class Referenceabstract

interface of a generic tag set in the tag-based data model. More...

#include <tags.h>

Inheritance diagram for siena::TagSet:
Inheritance graph
[legend]

Classes

class  Iterator
 iterator for a tag set. More...
 

Public Member Functions

virtual Iteratorfirst () const =0
 returns an iterator over this tag set. More...
 

Detailed Description

interface of a generic tag set in the tag-based data model.

An tag set is what it says it is: a set of tags. This basic interface defines an immutable tag set. Implementations of this interface may then have methods to add or remove tags. The tags in a tag set can be accessed sequentially through a TagSet::Iterator. The iteration order is implementation dependent.

Examples:
simple_tags_types.h.

Member Function Documentation

virtual Iterator* siena::TagSet::first ( ) const
pure virtual

returns an iterator over this tag set.

The iterator returned by this method must define a complete iteration through the tag set. The order of the iteration is implementation-dependent.

Returns
iterator pointing to the first tag in this tag set, or 0 (NULL) if this tag set is empty.
Examples:
simple_tags_types.h.