SH::TagList Class Reference

A class that manages a list of tags for identifying samples. More...

#include <TagList.h>

Collaboration diagram for SH::TagList:

Public Types
typedef std::set< std::string >::const_iterator	iterator
	the iterator to use More...

Public Member Functions
void	testInvariant () const
	test the invariant of this object More...
	TagList ()
	standard default constructor More...
	TagList (const std::string &tags, char separator=':')
	create a tag-list from a string More...
bool	has (const std::string &tag) const
	whether we have the given tag More...
iterator	begin () const
	the begin iterator to use More...
iterator	end () const
	the end iterator to use More...
std::string	join (char separator=':') const
	join all the tags together into a string More...
void	add (const std::string &tag)
	add a tag to the list More...

Private Types
typedef std::set< std::string >::const_iterator	TagsIter
	the iterator for m_tags More...

Private Attributes
std::set< std::string >	m_tags
	the list of tags More...

Related Functions
(Note that these are not member functions.)
std::string	dbg (const TagList &obj, unsigned verbosity=0)
	the debugging info of this object More...

Detailed Description

A class that manages a list of tags for identifying samples.

The idea is to use the marker to group samples according to their type. This is a bit of an old mechanism, and personally I prefer to rely on meta-data instead.

Definition at line 47 of file TagList.h.

Member Typedef Documentation

iterator

typedef std::set<std::string>::const_iterator SH::TagList::iterator

the iterator to use

Definition at line 96 of file TagList.h.

TagsIter

typedef std::set<std::string>::const_iterator SH::TagList::TagsIter

private

the iterator for m_tags

Definition at line 150 of file TagList.h.

Constructor & Destructor Documentation

TagList() [1/2]

SH::TagList::TagList

(

)

standard default constructor

Guarantee

strong

Failures

out of memory I

Definition at line 59 of file TagList.cxx.

  {
    RCU_NEW_INVARIANT (this);
  }

TagList() [2/2]

SH::TagList::TagList ( const std::string &  tags, char  separator = ':'  )

explicit

create a tag-list from a string

param tags the given list of tags param separator the character by which tags are separated in the list

Guarantee

strong

Failures

out of memory II

Definition at line 67 of file TagList.cxx.

  {
    std::string::const_iterator pos1, pos2 = tags.begin(), end = tags.end();
 
    while (pos2 != end)
    {
      for (pos1 = pos2; pos2 != end && *pos2 != separator; ++ pos2) {};
 
      if (pos2 != pos1)
    m_tags.insert (std::string (pos1, pos2));
      if (pos2 != end)
    ++ pos2;
    };
 
    RCU_NEW_INVARIANT (this);
  }

Member Function Documentation

add()

void SH::TagList::add

(

const std::string &

tag

)

add a tag to the list

Parameters

tag	the tag to add

Guarantee

strong

Failures

out of memory II

Definition at line 135 of file TagList.cxx.

  {
    RCU_CHANGE_INVARIANT (this);
 
    m_tags.insert (tag);
  }

begin()

TagList::iterator SH::TagList::begin

(

)

const

the begin iterator to use

Guarantee

no-fail

Definition at line 97 of file TagList.cxx.

  {
    RCU_READ_INVARIANT (this);
    return m_tags.begin();
  }

end()

TagList::iterator SH::TagList::end

(

)

const

the end iterator to use

Guarantee

no-fail

Definition at line 106 of file TagList.cxx.

  {
    RCU_READ_INVARIANT (this);
    return m_tags.end();
  }

has()

bool SH::TagList::has

(

const std::string &

tag

)

const

whether we have the given tag

Returns

whether we have the given tag

Precondition

!tag.empty()

Guarantee

no-fail

Definition at line 87 of file TagList.cxx.

  {
    RCU_READ_INVARIANT (this);
    RCU_REQUIRE_SOFT (!tag.empty());
    return m_tags.find (tag) != m_tags.end();
  }

join()

std::string SH::TagList::join

(

char

separator = ':'

)

const

join all the tags together into a string

Returns

the joined tags

Parameters

separator

the separator to use

Guarantee

strong

Failures

out of memory II
separator used within tag

Definition at line 115 of file TagList.cxx.

  {
    RCU_READ_INVARIANT (this);
 
    std::string result;
    for (TagsIter tag = m_tags.begin(), end = m_tags.end();
     tag != end; ++ tag)
    {
      if (tag->find (separator) != std::string::npos)
    RCU_THROW_MSG (std::string ("can't use separator ") + separator + " it is part of tag " + *tag);
      if (!result.empty())
    result += separator;
      result += *tag;
    };
    return result;
  }

testInvariant()

void SH::TagList::testInvariant

(

)

const

test the invariant of this object

Guarantee

no-fail

Definition at line 46 of file TagList.cxx.

  {
    for (TagsIter tag = m_tags.begin(),
       end = m_tags.end(); tag != end; ++ tag)
    {
      RCU_INVARIANT (!tag->empty());
      //RCU_INVARIANT (tag->find (':') == std::string::npos);
    };
  }

Friends And Related Function Documentation

dbg()

std::string dbg ( const TagList &  obj, unsigned  verbosity = 0  )

related

the debugging info of this object

Returns

a string representation of the object content

Parameters

obj	the object to be presented
verbosity	the level of verbosity (higher number -> more information)

Guarantee

strong

Failures

out of memory II

Definition at line 30 of file TagList.cxx.

  {
    std::string result;
 
    for (TagList::iterator tag = obj.begin(), end = obj.end();
     tag != end; ++ tag)
    {
      if (!result.empty())
    result += ",";
      result += *tag;
    };
    return "(" + result + ")";
  }

Member Data Documentation

m_tags

std::set<std::string> SH::TagList::m_tags

private

the list of tags

Definition at line 146 of file TagList.h.

---

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

• TagList.h
• TagList.cxx