TemplateVec.h

/**
 * @file TemplateVec.h
 * @date 2010-02-26
 * @author Thomas Fischer
 * @brief Definition of the GeoLib::TemplateVec class.
 *
 * @copyright
 * Copyright (c) 2012-2014, OpenGeoSys Community (http://www.opengeosys.org)
 *            Distributed under a Modified BSD License.
 *              See accompanying file LICENSE.txt or
 *              http://www.opengeosys.org/project/license
 *
 *
 */

#ifndef TEMPLATEVEC_H_
#define TEMPLATEVEC_H_

#include <algorithm>
#include <stdexcept>
#include <map>
#include <vector>
#include <string>

namespace GeoLib
{
/**
 * \ingroup GeoLib
 *
 * \brief The class TemplateVec takes a unique name and manages
 * a std::vector of pointers to data elements of type T.
 *
 * Instances are classes PolylineVec and SurfaceVec.
 * */
template <class T> class TemplateVec
{
protected:
	typedef std::pair<std::string, std::size_t> NameIdPair;
	typedef std::map<std::string, std::size_t> NameIdMap;
public:
	/**
	 * Constructor of class TemlateVec.
	 * @param name unique name of the project the elements belonging to.
	 * In order to access the data elements a unique name is required.
	 * @param data_vec Vector of data elements.
	 * @attention{TemplateVec will take the ownership of the vector
	 * and also its elements,
	 * i.e. delete its elements and delete the vector itself!}
	 * @param elem_name_map Names of data elements can be given by a
	 * std::map<std::string, std::size_t>. Here the std::string is the name
	 * of the element and the value for std::size_t stands for an index in
	 * the data_vec.
	 */
	TemplateVec (const std::string &name, std::vector<T*>* data_vec,
	             NameIdMap* elem_name_map = nullptr) :
		_name(name), _data_vec(data_vec), _name_id_map (elem_name_map)
	{
		if (_data_vec == nullptr) {
			throw std::invalid_argument("Constructor TemplateVec: vector of data elements is a nullptr.");
		}
		if (!_name_id_map)
			_name_id_map = new NameIdMap;
	}

	/**
	 * destructor, deletes all data elements
	 */
	virtual ~TemplateVec ()
	{
		for (std::size_t k(0); k < size(); k++) delete (*_data_vec)[k];
		delete _data_vec;
		delete _name_id_map;
	}

	/** sets the name of the vector of geometric objects
	 * the data elements belonging to
	 * \param n the name as standard string */
	void setName (const std::string & n) { _name = n; }
	/**
	 * the name, the data element belonging to
	 * @return the name of the object
	 */
	std::string getName () const { return _name; }

	/**
	 * @return the number of data elements
	 */
	std::size_t size () const { return _data_vec->size(); }

	/**
	 * get a pointer to a standard vector containing the data elements
	 * @return the data elements
	 */
	const std::vector<T*>* getVector () const { return _data_vec; }

	/**
	 * search the vector of names for the ID of the geometric element with the given name
	 * @param name the name of the geometric element
	 * @param id the id of the geometric element
	 */
	bool getElementIDByName (const std::string& name, std::size_t &id) const
	{
		auto it (_name_id_map->find (name));

		if (it != _name_id_map->end())
		{
			id = it->second;
			return true;
		}
		else return false;
	}

	/// Returns an element with the given name.
	const T* getElementByName (const std::string& name) const
	{
		std::size_t id;
		bool ret (getElementIDByName (name, id));
		if (ret)
			return (*_data_vec)[id];
		else
			return nullptr;
	}

	/**
	 * The method returns true if there is a name associated
	 * with the given id, else method returns false.
	 * @param id the id
	 * @param element_name if a name associated with the id
	 * is found name is assigned to element_name
	 * @return if there is name associated with the given id:
	 * true, else false
	 */
	bool getNameOfElementByID (std::size_t id, std::string& element_name) const
	{
		// search in map for id
		auto it = findFirstElementByID(id);
		if (it == _name_id_map->end()) {
			return false;
		}
		element_name = it->first;
		return true;
	}

	/// Return the name of an element based on its ID.
	void setNameOfElementByID (std::size_t id, std::string& element_name)
	{
		_name_id_map->insert(NameIdPair(element_name, id));
	}

	/**
	 * The method returns true if the given element of type T
	 * can be found and the element has a name, else method returns false.
	 * @param data the data element, one wants to know the name
	 * @param name the name of the data element (if the data element is
	 * found and the data element has a name)
	 * @return if element is found and has a name: true, else false
	 */
	bool getNameOfElement (const T* data, std::string& name) const
	{
		for (std::size_t k(0); k < _data_vec->size(); k++)
			if ((*_data_vec)[k] == data)
				return getNameOfElementByID (k, name);

		return false;
	}

	/// Adds a new element to the vector.
	virtual void push_back (T* data_element, std::string const* const name = nullptr)
	{
		_data_vec->push_back (data_element);
		if (!name || name->empty())
			return;

		_name_id_map->insert(NameIdPair(*name, _data_vec->size() - 1));
	}

	/// Sets the given name for the element of the given ID.
	void setNameForElement(std::size_t id, std::string const& name)
	{
		// Erase id if found in map.
		auto it = findFirstElementByID(id);
		if (it != _name_id_map->end())
			_name_id_map->erase(it);

		if (!name.empty()) {
			//insert new or revised name
			_name_id_map->insert(NameIdPair(name, id));
		}
	}

private:

	NameIdMap::const_iterator
	findFirstElementByID(std::size_t const& id) const
	{
		return std::find_if(_name_id_map->begin(), _name_id_map->end(),
			[id](NameIdPair const& elem) { return elem.second == id; });
	}

protected:
	/** copy constructor doesn't have an implementation */
	// compiler does not create a (possible unwanted) copy constructor
	TemplateVec (const TemplateVec &);
	/** assignment operator doesn't have an implementation */
	// this way the compiler does not create a (possible unwanted) assignment operator
	TemplateVec& operator= (const TemplateVec& rhs);

	/** the name of the object */
	std::string _name;

	/**
	 * pointer to a vector of data elements
	 */
	std::vector <T*>* _data_vec;
	/**
	 * store names associated with the element ids
	 */
	NameIdMap* _name_id_map;
};
} // end namespace GeoLib

#endif /* TEMPLATEVEC_H_ */