torc::generic::SymTab< _KeyType, _ValueType, cOverWriteExisting > Class Template Reference

A symbol table. More...

#include <SymTab.hpp>

Data Structures
struct	Data

Public Types
typedef _KeyType	KeyType
typedef _ValueType	ValueType
typedef std::map< KeyType, Data >	Map
typedef std::map< KeyType, ValueType >	UserMap

Public Member Functions
	SymTab ()
	~SymTab () throw ()
bool	get (const KeyType &inKey, ValueType &outValue) const
bool	set (const KeyType &inKey, const ValueType &inValue)
bool	remove (const KeyType &inKey)
void	getValues (std::vector< ValueType > &outValues) const
void	getValueMap (UserMap &outMap) const
size_t	getSize () const
void	clear ()
template<typename _Action >
void	applyOnAll (const _Action &action) throw (Error)

Private Attributes
Map	mValues
size_t	mNextValue

Detailed Description

template<typename _KeyType, typename _ValueType, bool cOverWriteExisting = false>
class torc::generic::SymTab< _KeyType, _ValueType, cOverWriteExisting >

A symbol table.

This class acts as a symbol table to store key-value pairs

Definition at line 38 of file SymTab.hpp.

Member Typedef Documentation

template<typename _KeyType, typename _ValueType, bool cOverWriteExisting = false>

typedef _KeyType torc::generic::SymTab< _KeyType, _ValueType, cOverWriteExisting >::KeyType

Definition at line 62 of file SymTab.hpp.

template<typename _KeyType, typename _ValueType, bool cOverWriteExisting = false>

typedef std::map<KeyType, Data> torc::generic::SymTab< _KeyType, _ValueType, cOverWriteExisting >::Map

Definition at line 64 of file SymTab.hpp.

template<typename _KeyType, typename _ValueType, bool cOverWriteExisting = false>

typedef std::map<KeyType, ValueType> torc::generic::SymTab< _KeyType, _ValueType, cOverWriteExisting >::UserMap

Definition at line 65 of file SymTab.hpp.

template<typename _KeyType, typename _ValueType, bool cOverWriteExisting = false>

typedef _ValueType torc::generic::SymTab< _KeyType, _ValueType, cOverWriteExisting >::ValueType

Definition at line 63 of file SymTab.hpp.

Constructor & Destructor Documentation

template<typename _KeyType , typename _ValueType , bool cOverWriteExisting>

torc::generic::SymTab< _KeyType, _ValueType, cOverWriteExisting >::SymTab

(

)

Definition at line 114 of file SymTab.hpp.

                                                         :
    mValues(), mNextValue(0) {}

template<typename _KeyType , typename _ValueType , bool cOverWriteExisting>

torc::generic::SymTab< _KeyType, _ValueType, cOverWriteExisting >::~SymTab	(		)
throw	(
	)

Definition at line 118 of file SymTab.hpp.

{}

Member Function Documentation

template<typename _KeyType , typename _ValueType , bool cOverWriteExisting>

template<typename _Action >

void torc::generic::SymTab< _KeyType, _ValueType, cOverWriteExisting >::applyOnAll ( const _Action &  action ) throw ( Error )

inline

Definition at line 192 of file SymTab.hpp.

                                         {
    std::vector<Data> values;
    for(typename Map::const_iterator it = mValues.begin(); it != mValues.end(); ++it) {
        values.push_back((*it).second);
    }
    sort(values.begin(), values.end(), std::less<Data>());
    for(typename std::vector<Data>::iterator value = values.begin(); value != values.end();
        ++value) {
        try {
            action((*value).mValue);
        } catch(Error& e) {
            e.setCurrentLocation(__FUNCTION__, __FILE__, __LINE__);
            throw;
        }
    }
}

Here is the call graph for this function:

Here is the caller graph for this function:

template<typename _KeyType , typename _ValueType , bool cOverWriteExisting>

void torc::generic::SymTab< _KeyType, _ValueType, cOverWriteExisting >::clear ( void  )

inline

Definition at line 187 of file SymTab.hpp.

                                                     {
    mValues.clear();
}

Here is the call graph for this function:

Here is the caller graph for this function:

template<typename _KeyType , typename _ValueType , bool cOverWriteExisting>

bool torc::generic::SymTab< _KeyType, _ValueType, cOverWriteExisting >::get ( const KeyType &  inKey, ValueType &  outValue  ) const

inline

Get a value for a key

Parameters

[in]	inKey	key to look for
[out]	outValue	resultant value

Returns

true if object was found

Definition at line 121 of file SymTab.hpp.

                               {
    typename Map::const_iterator it = mValues.find(inKey);
    if(it == mValues.end()) {
        return false;
    }
    outValue = (*it).second.mValue;
    return true;
}

Here is the caller graph for this function:

template<typename _KeyType , typename _ValueType , bool cOverWriteExisting>

size_t torc::generic::SymTab< _KeyType, _ValueType, cOverWriteExisting >::getSize ( void  ) const

inline

Definition at line 182 of file SymTab.hpp.

                                                             {
    return mValues.size();
}

template<typename _KeyType, typename _ValueType, bool cOverWriteExisting = false>

void torc::generic::SymTab< _KeyType, _ValueType, cOverWriteExisting >::getValueMap ( UserMap &  outMap ) const

inline

Definition at line 171 of file SymTab.hpp.

                                                                                    {

    for(typename Map::const_iterator it = mValues.begin(); it != mValues.end(); ++it) {
        typename UserMap::value_type value = std::make_pair((*it).first, (*it).second.mValue);
        outMap.insert(value);
    }
    return;
}

Here is the caller graph for this function:

template<typename _KeyType , typename _ValueType , bool cOverWriteExisting>

void torc::generic::SymTab< _KeyType, _ValueType, cOverWriteExisting >::getValues ( std::vector< ValueType > &  outValues ) const

inline

Definition at line 158 of file SymTab.hpp.

                                                                                              {
    std::vector<Data> values;
    for(typename Map::const_iterator it = mValues.begin(); it != mValues.end(); ++it) {
        values.push_back((*it).second);
    }
    sort(values.begin(), values.end(), std::less<Data>());
    for(typename std::vector<Data>::iterator it = values.begin(); it != values.end(); ++it) {
        outValues.push_back((*it).mValue);
    }
    return;
}

Here is the caller graph for this function:

template<typename _KeyType , typename _ValueType , bool cOverWriteExisting>

bool torc::generic::SymTab< _KeyType, _ValueType, cOverWriteExisting >::remove ( const KeyType &  inKey )

inline

Remove a value for a key

Parameters

[in]

inKey

key to look for

Returns

true if object was removed

Definition at line 153 of file SymTab.hpp.

                                                                          {
    return mValues.erase(inKey) > 0;
}

Here is the caller graph for this function:

template<typename _KeyType , typename _ValueType , bool cOverWriteExisting>

bool torc::generic::SymTab< _KeyType, _ValueType, cOverWriteExisting >::set ( const KeyType &  inKey, const ValueType &  inValue  )

inline

Set a value for a key. If cOverWriteExisting is true, Existing value will be replaced.

Parameters

[in]	inKey	key to look for
[in]	inValue	value to be stored

Returns

True if value was inserted

Definition at line 132 of file SymTab.hpp.

                                                                                                 {
    Data data;
    data.mIndex = mNextValue;
    data.mValue = inValue;
    mNextValue++;
    typename Map::value_type value = std::make_pair(inKey, data);

    std::pair<typename Map::iterator, bool> res = mValues.insert(value);
    if(false == res.second) {
        if(cOverWriteExisting) {
            mValues.erase(res.first);
            mValues.insert(value);
        } else {
            mNextValue--;
            return false;
        }
    }
    return true;
}

Here is the caller graph for this function:

Field Documentation

template<typename _KeyType, typename _ValueType, bool cOverWriteExisting = false>

size_t torc::generic::SymTab< _KeyType, _ValueType, cOverWriteExisting >::mNextValue

private

Definition at line 110 of file SymTab.hpp.

template<typename _KeyType, typename _ValueType, bool cOverWriteExisting = false>

Map torc::generic::SymTab< _KeyType, _ValueType, cOverWriteExisting >::mValues

private

Definition at line 108 of file SymTab.hpp.

---

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

• SymTab.hpp