ACE_Cache_Map_Iterator< KEY, VALUE, IMPLEMENTATION, CACHING_STRATEGY, ATTRIBUTES > Class Template Reference

Defines a iterator for the Cache_Map_Manager. More...

#include <Cache_Map_Manager_T.h>

Collaboration diagram for ACE_Cache_Map_Iterator< KEY, VALUE, IMPLEMENTATION, CACHING_STRATEGY, ATTRIBUTES >:

Collaboration graph
[legend]
List of all members.

Public Types

typedef ACE_Reference_Pair<
KEY, VALUE > 		value_type
typedef ACE_Pair< VALUE, ATTRIBUTES > CACHE_VALUE

Public Member Functions

 ACE_Cache_Map_Iterator (const IMPLEMENTATION &iterator_impl)
 ACE_Cache_Map_Iterator (const ACE_Cache_Map_Iterator< KEY, VALUE, IMPLEMENTATION, CACHING_STRATEGY, ATTRIBUTES > &rhs)
 Copy constructor.
virtual ~ACE_Cache_Map_Iterator (void)
ACE_Cache_Map_Iterator< KEY,
VALUE, IMPLEMENTATION, CACHING_STRATEGY,
ATTRIBUTES > & 		operator= (const ACE_Cache_Map_Iterator< KEY, VALUE, IMPLEMENTATION, CACHING_STRATEGY, ATTRIBUTES > &rhs)
 assignment operator.
bool operator== (const ACE_Cache_Map_Iterator< KEY, VALUE, IMPLEMENTATION, CACHING_STRATEGY, ATTRIBUTES > &rhs) const
 Comparision operators.
bool operator!= (const ACE_Cache_Map_Iterator< KEY, VALUE, IMPLEMENTATION, CACHING_STRATEGY, ATTRIBUTES > &rhs) const
ACE_Reference_Pair< KEY, VALUE > operator * (void) const
ACE_Cache_Map_Iterator< KEY,
VALUE, IMPLEMENTATION, CACHING_STRATEGY,
ATTRIBUTES > & 		operator++ (void)
 Prefix advance.
ACE_Cache_Map_Iterator< KEY,
VALUE, IMPLEMENTATION, CACHING_STRATEGY,
ATTRIBUTES > 		operator++ (int)
 Postfix advance.
ACE_Cache_Map_Iterator< KEY,
VALUE, IMPLEMENTATION, CACHING_STRATEGY,
ATTRIBUTES > & 		operator-- (void)
 Prefix reverse.
ACE_Cache_Map_Iterator< KEY,
VALUE, IMPLEMENTATION, CACHING_STRATEGY,
ATTRIBUTES > 		operator-- (int)
 Postfix reverse.
IMPLEMENTATION & iterator_implementation (void)
void dump (void) const
 Dump the state of an object.

Public Attributes

 ACE_ALLOC_HOOK_DECLARE
 Declare the dynamic allocation hooks.

Protected Attributes

IMPLEMENTATION iterator_implementation_

Detailed Description

template<class KEY, class VALUE, class IMPLEMENTATION, class CACHING_STRATEGY, class ATTRIBUTES>
class ACE_Cache_Map_Iterator< KEY, VALUE, IMPLEMENTATION, CACHING_STRATEGY, ATTRIBUTES >

Defines a iterator for the Cache_Map_Manager.

Implementation to be provided by the iterator of the map managed by the ACE_Cache_Map_Manager.

Definition at line 247 of file Cache_Map_Manager_T.h.

Member Typedef Documentation

template<class KEY, class VALUE, class IMPLEMENTATION, class CACHING_STRATEGY, class ATTRIBUTES>
typedef ACE_Pair<VALUE, ATTRIBUTES> ACE_Cache_Map_Iterator< KEY, VALUE, IMPLEMENTATION, CACHING_STRATEGY, ATTRIBUTES >::CACHE_VALUE

Definition at line 258 of file Cache_Map_Manager_T.h.

template<class KEY, class VALUE, class IMPLEMENTATION, class CACHING_STRATEGY, class ATTRIBUTES>
typedef ACE_Reference_Pair<KEY, VALUE> ACE_Cache_Map_Iterator< KEY, VALUE, IMPLEMENTATION, CACHING_STRATEGY, ATTRIBUTES >::value_type

The actual value mapped to the key in the cache. The <attributes> are used by the strategy and is transperant to the cache user.

Definition at line 256 of file Cache_Map_Manager_T.h.

Constructor & Destructor Documentation

template<class KEY, class VALUE, class IMPLEMENTATION, class CACHING_STRATEGY, class ATTRIBUTES>
ACE_INLINE ACE_Cache_Map_Iterator< KEY, VALUE, IMPLEMENTATION, CACHING_STRATEGY, ATTRIBUTES >::ACE_Cache_Map_Iterator ( const IMPLEMENTATION &  iterator_impl  ) 

Definition at line 139 of file Cache_Map_Manager_T.inl.

00140   : iterator_implementation_ (iterator_impl)
00141 {
00142 }

template<class KEY, class VALUE, class IMPLEMENTATION, class CACHING_STRATEGY, class ATTRIBUTES>
ACE_INLINE ACE_Cache_Map_Iterator< KEY, VALUE, IMPLEMENTATION, CACHING_STRATEGY, ATTRIBUTES >::ACE_Cache_Map_Iterator ( const ACE_Cache_Map_Iterator< KEY, VALUE, IMPLEMENTATION, CACHING_STRATEGY, ATTRIBUTES > &  rhs  ) 

Copy constructor.

Definition at line 64 of file Cache_Map_Manager_T.inl.

00065   : iterator_implementation_ (rhs.iterator_implementation_)
00066 {
00067 }

template<class KEY, class VALUE, class IMPLEMENTATION, class CACHING_STRATEGY, class ATTRIBUTES>
ACE_Cache_Map_Iterator< KEY, VALUE, IMPLEMENTATION, CACHING_STRATEGY, ATTRIBUTES >::~ACE_Cache_Map_Iterator ( void   )  [virtual]

Definition at line 414 of file Cache_Map_Manager_T.cpp.

00415 {
00416 }

Member Function Documentation

template<class KEY, class VALUE, class IMPLEMENTATION, class CACHING_STRATEGY, class ATTRIBUTES>
ACE_INLINE void ACE_Cache_Map_Iterator< KEY, VALUE, IMPLEMENTATION, CACHING_STRATEGY, ATTRIBUTES >::dump ( void   )  const

Dump the state of an object.

Definition at line 131 of file Cache_Map_Manager_T.inl.

References ACE_Cache_Map_Iterator< KEY, VALUE, IMPLEMENTATION, CACHING_STRATEGY, ATTRIBUTES >::iterator_implementation_.

00132 {
00133 #if defined (ACE_HAS_DUMP)
00134   this->iterator_implementation_.dump ();
00135 #endif /* ACE_HAS_DUMP */
00136 }

template<class KEY, class VALUE, class IMPLEMENTATION, class CACHING_STRATEGY, class ATTRIBUTES>
ACE_INLINE IMPLEMENTATION & ACE_Cache_Map_Iterator< KEY, VALUE, IMPLEMENTATION, CACHING_STRATEGY, ATTRIBUTES >::iterator_implementation ( void   ) 

Returns the iterator of the internal map in the custody of the Cache_Map_Manager.

Definition at line 145 of file Cache_Map_Manager_T.inl.

References ACE_Cache_Map_Iterator< KEY, VALUE, IMPLEMENTATION, CACHING_STRATEGY, ATTRIBUTES >::iterator_implementation_.

00146 {
00147   return this->iterator_implementation_;
00148 }

template<class KEY, class VALUE, class IMPLEMENTATION, class CACHING_STRATEGY, class ATTRIBUTES>
ACE_INLINE ACE_Reference_Pair< KEY, VALUE > ACE_Cache_Map_Iterator< KEY, VALUE, IMPLEMENTATION, CACHING_STRATEGY, ATTRIBUTES >::operator * ( void   )  const

Returns a reference to the internal element this is pointing to.

Definition at line 89 of file Cache_Map_Manager_T.inl.

00090 {
00091   value_type retn ((*this->iterator_implementation_).ext_id_,
00092                    (*this->iterator_implementation_).int_id_.first ());
00093   return retn;
00094 }

template<class KEY, class VALUE, class IMPLEMENTATION, class CACHING_STRATEGY, class ATTRIBUTES>
ACE_INLINE bool ACE_Cache_Map_Iterator< KEY, VALUE, IMPLEMENTATION, CACHING_STRATEGY, ATTRIBUTES >::operator!= ( const ACE_Cache_Map_Iterator< KEY, VALUE, IMPLEMENTATION, CACHING_STRATEGY, ATTRIBUTES > &  rhs  )  const

Definition at line 83 of file Cache_Map_Manager_T.inl.

References ACE_Cache_Map_Iterator< KEY, VALUE, IMPLEMENTATION, CACHING_STRATEGY, ATTRIBUTES >::iterator_implementation_.

00084 {
00085   return this->iterator_implementation_ != rhs.iterator_implementation_;
00086 }

template<class KEY, class VALUE, class IMPLEMENTATION, class CACHING_STRATEGY, class ATTRIBUTES>
ACE_INLINE ACE_Cache_Map_Iterator< KEY, VALUE, IMPLEMENTATION, CACHING_STRATEGY, ATTRIBUTES > ACE_Cache_Map_Iterator< KEY, VALUE, IMPLEMENTATION, CACHING_STRATEGY, ATTRIBUTES >::operator++ ( int   ) 

Postfix advance.

Definition at line 106 of file Cache_Map_Manager_T.inl.

References ACE_Cache_Map_Iterator< KEY, VALUE, IMPLEMENTATION, CACHING_STRATEGY, ATTRIBUTES >::iterator_implementation_.

00107 {
00108   ACE_Cache_Map_Iterator<KEY, VALUE, IMPLEMENTATION, CACHING_STRATEGY, ATTRIBUTES> retn = *this;
00109   ++this->iterator_implementation_;
00110   return retn;
00111 }

template<class KEY, class VALUE, class IMPLEMENTATION, class CACHING_STRATEGY, class ATTRIBUTES>
ACE_INLINE ACE_Cache_Map_Iterator< KEY, VALUE, IMPLEMENTATION, CACHING_STRATEGY, ATTRIBUTES > & ACE_Cache_Map_Iterator< KEY, VALUE, IMPLEMENTATION, CACHING_STRATEGY, ATTRIBUTES >::operator++ ( void   ) 

Prefix advance.

Definition at line 98 of file Cache_Map_Manager_T.inl.

References ACE_Cache_Map_Iterator< KEY, VALUE, IMPLEMENTATION, CACHING_STRATEGY, ATTRIBUTES >::iterator_implementation_.

00099 {
00100   ++this->iterator_implementation_;
00101   return *this;
00102 }

template<class KEY, class VALUE, class IMPLEMENTATION, class CACHING_STRATEGY, class ATTRIBUTES>
ACE_INLINE ACE_Cache_Map_Iterator< KEY, VALUE, IMPLEMENTATION, CACHING_STRATEGY, ATTRIBUTES > ACE_Cache_Map_Iterator< KEY, VALUE, IMPLEMENTATION, CACHING_STRATEGY, ATTRIBUTES >::operator-- ( int   ) 

Postfix reverse.

Definition at line 123 of file Cache_Map_Manager_T.inl.

References ACE_Cache_Map_Iterator< KEY, VALUE, IMPLEMENTATION, CACHING_STRATEGY, ATTRIBUTES >::iterator_implementation_.

00124 {
00125   ACE_Cache_Map_Iterator<KEY, VALUE, IMPLEMENTATION, CACHING_STRATEGY, ATTRIBUTES> retn = *this;
00126   --this->iterator_implementation_;
00127   return retn;
00128 }

template<class KEY, class VALUE, class IMPLEMENTATION, class CACHING_STRATEGY, class ATTRIBUTES>
ACE_INLINE ACE_Cache_Map_Iterator< KEY, VALUE, IMPLEMENTATION, CACHING_STRATEGY, ATTRIBUTES > & ACE_Cache_Map_Iterator< KEY, VALUE, IMPLEMENTATION, CACHING_STRATEGY, ATTRIBUTES >::operator-- ( void   ) 

Prefix reverse.

Definition at line 115 of file Cache_Map_Manager_T.inl.

References ACE_Cache_Map_Iterator< KEY, VALUE, IMPLEMENTATION, CACHING_STRATEGY, ATTRIBUTES >::iterator_implementation_.

00116 {
00117   --this->iterator_implementation_;
00118   return *this;
00119 }

template<class KEY, class VALUE, class IMPLEMENTATION, class CACHING_STRATEGY, class ATTRIBUTES>
ACE_INLINE ACE_Cache_Map_Iterator< KEY, VALUE, IMPLEMENTATION, CACHING_STRATEGY, ATTRIBUTES > & ACE_Cache_Map_Iterator< KEY, VALUE, IMPLEMENTATION, CACHING_STRATEGY, ATTRIBUTES >::operator= ( const ACE_Cache_Map_Iterator< KEY, VALUE, IMPLEMENTATION, CACHING_STRATEGY, ATTRIBUTES > &  rhs  ) 

assignment operator.

Definition at line 70 of file Cache_Map_Manager_T.inl.

References ACE_Cache_Map_Iterator< KEY, VALUE, IMPLEMENTATION, CACHING_STRATEGY, ATTRIBUTES >::iterator_implementation_.

00071 {
00072   this->iterator_implementation_ = rhs.iterator_implementation_;
00073   return *this;
00074 }

template<class KEY, class VALUE, class IMPLEMENTATION, class CACHING_STRATEGY, class ATTRIBUTES>
ACE_INLINE bool ACE_Cache_Map_Iterator< KEY, VALUE, IMPLEMENTATION, CACHING_STRATEGY, ATTRIBUTES >::operator== ( const ACE_Cache_Map_Iterator< KEY, VALUE, IMPLEMENTATION, CACHING_STRATEGY, ATTRIBUTES > &  rhs  )  const

Comparision operators.

Definition at line 77 of file Cache_Map_Manager_T.inl.

References ACE_Cache_Map_Iterator< KEY, VALUE, IMPLEMENTATION, CACHING_STRATEGY, ATTRIBUTES >::iterator_implementation_.

00078 {
00079   return this->iterator_implementation_ == rhs.iterator_implementation_;
00080 }

Member Data Documentation

template<class KEY, class VALUE, class IMPLEMENTATION, class CACHING_STRATEGY, class ATTRIBUTES>
ACE_Cache_Map_Iterator< KEY, VALUE, IMPLEMENTATION, CACHING_STRATEGY, ATTRIBUTES >::ACE_ALLOC_HOOK_DECLARE

Declare the dynamic allocation hooks.

Definition at line 307 of file Cache_Map_Manager_T.h.

template<class KEY, class VALUE, class IMPLEMENTATION, class CACHING_STRATEGY, class ATTRIBUTES>
IMPLEMENTATION ACE_Cache_Map_Iterator< KEY, VALUE, IMPLEMENTATION, CACHING_STRATEGY, ATTRIBUTES >::iterator_implementation_ [protected]

The actual iterator which iterates internally on the map belonging to the Cache_Map_Manager.

Definition at line 312 of file Cache_Map_Manager_T.h.

Referenced by ACE_Cache_Map_Iterator< KEY, VALUE, IMPLEMENTATION, CACHING_STRATEGY, ATTRIBUTES >::dump(), ACE_Cache_Map_Iterator< KEY, VALUE, IMPLEMENTATION, CACHING_STRATEGY, ATTRIBUTES >::iterator_implementation(), ACE_Cache_Map_Iterator< KEY, VALUE, IMPLEMENTATION, CACHING_STRATEGY, ATTRIBUTES >::operator!=(), ACE_Cache_Map_Iterator< KEY, VALUE, IMPLEMENTATION, CACHING_STRATEGY, ATTRIBUTES >::operator++(), ACE_Cache_Map_Iterator< KEY, VALUE, IMPLEMENTATION, CACHING_STRATEGY, ATTRIBUTES >::operator--(), ACE_Cache_Map_Iterator< KEY, VALUE, IMPLEMENTATION, CACHING_STRATEGY, ATTRIBUTES >::operator=(), and ACE_Cache_Map_Iterator< KEY, VALUE, IMPLEMENTATION, CACHING_STRATEGY, ATTRIBUTES >::operator==().

The documentation for this class was generated from the following files:
Generated on Tue Feb 2 17:34:57 2010 for ACE by  doxygen 1.4.7