vpr::AttributeMapBase Class Reference

Basic interface for adding attributes to classes. More...

#include <vpr/Util/AttributeMapBase.h>

Inheritance diagram for vpr::AttributeMapBase:

[legend]List of all members.

Public Member Functions
template<typename TYPE>
void	setAttrib (const std::string &name, TYPE val)
	Sets an attribute to the given value.
template<typename TYPE>
TYPE	getAttrib (const std::string &name)
	Gets an attribute value.
bool	attribExists (const std::string &name)
	Does the named attribute exist?

---

Detailed Description

Basic interface for adding attributes to classes.

Useful for having custom setter/getter type settings that are only used in certain contexts.

This is based upon boost::any type.

Definition at line 63 of file AttributeMapBase.h.

---

Member Function Documentation

template<typename TYPE>

void vpr::AttributeMapBase::setAttrib	(	const std::string &	name,
		TYPE	val
	)			[inline]

Sets an attribute to the given value.

Parameters:

	name	The name of the attribute to set.
	val	The value to be set.

Definition at line 73 of file AttributeMapBase.h.

   {
      mAttribMap[name] = val;
   }

template<typename TYPE>

TYPE vpr::AttributeMapBase::getAttrib

(

const std::string &

name

)

[inline]

Gets an attribute value.

If not previously set, then return the value of a default constructed instance of the given type.

Definition at line 85 of file AttributeMapBase.h.

References attribExists().

   {
      TYPE ret_val;     // Construct default return value
      if(attribExists(name))
      {
         boost::any any_val = mAttribMap[name];
         try
         {
            ret_val = boost::any_cast<TYPE>(any_val);
         }
         catch(const boost::bad_any_cast&)
         {
            ret_val = TYPE();    // Default value
         }
      }
      return ret_val;
   }

bool vpr::AttributeMapBase::attribExists

(

const std::string &

name

)

[inline]

Does the named attribute exist?

Returns:

true if it exists.

Definition at line 107 of file AttributeMapBase.h.

Referenced by getAttrib().

   {
      attrib_map_t::iterator found = mAttribMap.find(name);
      return (found != mAttribMap.end());
   }

---

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

• AttributeMapBase.h

---