sl@0: // Copyright (c) 2004-2009 Nokia Corporation and/or its subsidiary(-ies).
sl@0: // All rights reserved.
sl@0: // This component and the accompanying materials are made available
sl@0: // under the terms of "Eclipse Public License v1.0"
sl@0: // which accompanies this distribution, and is available
sl@0: // at the URL "http://www.eclipse.org/legal/epl-v10.html".
sl@0: //
sl@0: // Initial Contributors:
sl@0: // Nokia Corporation - initial contribution.
sl@0: //
sl@0: // Contributors:
sl@0: //
sl@0: // Description:
sl@0: // RMap template class declaration.
sl@0: // 
sl@0: //
sl@0: 
sl@0: #ifndef __D32MAP_H__
sl@0: #define __D32MAP_H__
sl@0: 
sl@0: #include "D32Assert.h"
sl@0: 
sl@0: /**
sl@0: (KEY, DATA) template pair class used by RMap template class.
sl@0: @internalComponent
sl@0: */
sl@0: template <class KEY, class DATA> 
sl@0: struct TPair
sl@0: 	{
sl@0: 	TPair(const KEY& aKey, const DATA& aData);
sl@0: 	TPair(const KEY& aKey);
sl@0: 	TPair();
sl@0: 	KEY		iKey;
sl@0: 	DATA	iData;
sl@0: 	};
sl@0: 
sl@0: //Forward declaration
sl@0: template <class KEY, class DATA> class RMap;
sl@0: 
sl@0: /**
sl@0: TMapIterator class. It describes an object which can be used as a 
sl@0: forward read-only iterator for sequence of type RMap.
sl@0: @internalComponent
sl@0: */
sl@0: template <class KEY, class DATA> 
sl@0: class TMapIterator
sl@0: 	{
sl@0: public:
sl@0: 	TMapIterator(const RMap<KEY, DATA>& aMap);
sl@0: 	void Reset();
sl@0: 	TBool Next(TPair<KEY, DATA>& aPair) const;
sl@0: private:
sl@0: 	const RMap<KEY, DATA>&	iMap;
sl@0: 	mutable TInt			iIndex;
sl@0: 	};
sl@0: 
sl@0: /**
sl@0: RMap template class describes an object that controls an ordered sequence of entries.
sl@0: Each entry has a key of type KEY and an associated with it data of type DATA.
sl@0: No entries with duplicated keys are allowed.
sl@0: The algorithm for determining the order of two entries is provided by a TLinearOrder
sl@0: object, supplied by the client of RMap during RMap instance construction.
sl@0: @internalComponent
sl@0: */
sl@0: template <class KEY, class DATA> 
sl@0: class RMap
sl@0: 	{
sl@0: 	friend class TMapIterator<KEY, DATA>;
sl@0: public:
sl@0: 	RMap(const TLinearOrder< TPair<KEY, DATA> >& aOrder);
sl@0: 	void Close();
sl@0: 	TInt Insert(const KEY& aKey, const DATA& aData);
sl@0: 	void Remove(const KEY& aKey);
sl@0: 	const DATA& operator[](const KEY& aKey) const;
sl@0: 	TInt Find(const KEY& aKey, DATA& aData) const;
sl@0: 	TInt Count() const;
sl@0: 
sl@0: private:
sl@0: 	TLinearOrder< TPair<KEY, DATA> >	iOrder;
sl@0: 	RArray< TPair<KEY, DATA> >			iCol;
sl@0: 
sl@0: 	};
sl@0: 
sl@0: #include "D32Map.inl"
sl@0: 
sl@0: #endif//__D32MAP_H__