|| ||           || Doxygen's  

---

HxTagList Class Reference

A list of tags. More...

#include <HxTagList.h>

List of all members.

Public Types
typedef HxTag *	TagPtr
	Type definition for a pointer to an HxTag. More...
typedef std::list< TagPtr >	List
	Type definition for a list of tag pointers. More...
Public Methods
	HxTagList ()
	Constructor. More...
	HxTagList (const HxTagList &)
	Copy constructor. More...
	~HxTagList ()
	Destructor. More...
HxTagList &	operator= (const HxTagList &)
	Assignment operator. More...
void	erase ()
	Make the tag list empty. More...
void	addTag (HxTag *)
	Add a tag, use via HxAddTag. More...
HxTag *	getTag (HxString name) const
	Get a tag, use via HxGetTag. More...
HxString	toString () const
	Make a sttring with names of all tags. More...
std::ostream &	put (std::ostream &) const
	To put the list on an ostream. More...

---

Detailed Description

A list of tags.

Basically, a tag is a combination of a name and a value. The name is represented by an HxString and the value is represented by an instantiation of HxTagTem, which is a specialization of HxTag. A value can be anything as long as it can be copy-constructed.

Use HxAddTag to add tags to the list. Use HxGetTag(const HxTagList&,HxString) and HxGetTag(const HxTagList&,HxString,ValT) to obtain values stored in the list. Use HxTagIsSet to check whether a tag is in the list.

---

Member Typedef Documentation

typedef HxTag* HxTagList::TagPtr

Type definition for a pointer to an HxTag.

typedef std::list<TagPtr> HxTagList::List

Type definition for a list of tag pointers.

---

Constructor & Destructor Documentation

HxTagList::HxTagList (    )  [inline]

Constructor. {}

HxTagList::HxTagList (  const HxTagList &    rhs )

Copy constructor. { List::const_iterator ptr; for (ptr = rhs._list.begin(); ptr != rhs._list.end(); ptr++) { _list.push_back((*ptr)->clone()); } }

HxTagList::~HxTagList (    )

Destructor. { List::iterator ptr; for (ptr = _list.begin(); ptr != _list.end(); ptr++) delete (*ptr); }

---

Member Function Documentation

HxTagList & HxTagList::operator= (  const HxTagList &    rhs )

Assignment operator. { List::const_iterator ptr; for (ptr = _list.begin(); ptr != _list.end(); ptr++) delete (*ptr); _list.erase(_list.begin(), _list.end()); for (ptr = rhs._list.begin(); ptr != rhs._list.end(); ptr++) { _list.push_back((*ptr)->clone()); } return *this; }

void HxTagList::erase (    )

Make the tag list empty. { List::const_iterator ptr; for (ptr = _list.begin(); ptr != _list.end(); ptr++) delete (*ptr); _list.erase(_list.begin(), _list.end()); }

void HxTagList::addTag (  HxTag *    tag )

Add a tag, use via HxAddTag. { List::iterator ptr = findTag(tag->getName()); if (ptr != _list.end() ) { delete (*ptr); _list.erase(ptr); } _list.push_front(tag); }

HxTag * HxTagList::getTag (  HxString    name )  const

Get a tag, use via HxGetTag. { List::const_iterator ptr = findTag(name); return ptr != _list.end() ? (*ptr) : 0; }

HxString HxTagList::toString (    )  const

Make a sttring with names of all tags. { int i = 0; HxString s("("); List::const_iterator ptr; for (ptr = _list.begin(); ptr != _list.end(); ptr++) { if (i > 0) s += ", "; s += (*ptr)->getName(); } s += ")"; return s; }

std::ostream & HxTagList::put (  std::ostream &    os )  const

To put the list on an ostream. { List::const_iterator ptr; for (ptr = _list.begin(); ptr != _list.end(); ptr++) os << (*ptr) << STD_ENDL; return os; }

---

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

• HxTagList.h
• HxTagList.c

---