tom::tsdb::alias_set Class Reference

#include <tom-tsdb/time_series.hpp>

Inheritance diagram for tom::tsdb::alias_set:

Collaboration diagram for tom::tsdb::alias_set:

Public Types
typedef parent_type::const_iterator	const_iterator
typedef parent_type::iterator	iterator
typedef std::set< tom::string, std::less< tom::string > >	parent_type

Public Member Functions
	alias_set ()
	alias_set (const alias_set &rhs)
template<typename IteratorT >
	alias_set (IteratorT begin, IteratorT end)
bool	add (const char *)
bool	add (const tom::observation &)
bool	add (const tom::string &)
const_iterator	begin () const
bool	changed () const
void	clear ()
const_iterator	end () const
bool	operator!= (const alias_set &rhs)
alias_set &	operator= (const alias_set &rhs)
bool	operator== (const alias_set &rhs)
bool	remove (const char *)
bool	remove (const tom::observation &)
bool	remove (const tom::string &)

Protected Attributes
bool	m_changed

Detailed Description

alias_set objects are std::set<tom::string> derivatives for the management of time_series aliases. All time_series objects have an associated alias_set object, though it may be empty.

Constructor & Destructor Documentation

alias_set() [1/3]

tom::tsdb::alias_set::alias_set ( )

inline

create an empty alias_set

alias_set() [2/3]

template<typename IteratorT >

tom::tsdb::alias_set::alias_set ( IteratorT  begin, IteratorT  end  )

inline

create an alias_set populated with the items pointed to by the begin -> end iterators

alias_set() [3/3]

tom::tsdb::alias_set::alias_set ( const alias_set &  rhs )

inline

make a copy of another alias_set

Member Function Documentation

add() [1/3]

bool tom::tsdb::alias_set::add

(

const char *

s

)

add a new alias to the alias_set. Aliases will be checked for uniqueness, and duplicates are automatically ignored.

add() [2/3]

bool tom::tsdb::alias_set::add

(

const tom::observation &

s

)

add a new alias to the alias_set. Aliases will be checked for uniqueness, and duplicates are automatically ignored.

add() [3/3]

bool tom::tsdb::alias_set::add

(

const tom::string &

s

)

add a new alias to the alias_set. Aliases will be checked for uniqueness, and duplicates are automatically ignored.

begin()

const_iterator tom::tsdb::alias_set::begin ( ) const

inline

get a const_iterator for the first item in the alias_set used to iterate over the alias_set. NO mutable iterators are available as access should go throw the parent alias_set.

changed()

bool tom::tsdb::alias_set::changed

(

)

const

check if any changes been made to the alias_set This is mainly useful for persistence back-ends that want to see if changes to aliases should be recorded.

clear()

void tom::tsdb::alias_set::clear ( )

inline

Empty the alias_set.

end()

const_iterator tom::tsdb::alias_set::end ( ) const

inline

get a const_iterator representing the end of the alias_set.

operator!=()

bool tom::tsdb::alias_set::operator!= ( const alias_set &  rhs )

inline

check if the contents of alias_set objects are different

operator=()

alias_set & tom::tsdb::alias_set::operator= ( const alias_set &  rhs )

inline

assign the contents of another alias_set to this alias_set

operator==()

bool tom::tsdb::alias_set::operator== ( const alias_set &  rhs )

inline

check if the contents of alias_set objects are the same

remove() [1/3]

bool tom::tsdb::alias_set::remove

(

const char *

s

)

remove an alias from the alias_set.
If not found false will be returned.

remove() [2/3]

bool tom::tsdb::alias_set::remove

(

const tom::observation &

s

)

remove an alias from the alias_set.
If not found false will be returned.

remove() [3/3]

bool tom::tsdb::alias_set::remove

(

const tom::string &

s

)

remove an alias from the alias_set.
If not found false will be returned.

---

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

• tom-tsdb/time_series.hpp
• time_series.cpp