1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172
|
.TH ACE_Cache_Map_Iterator 3 "1 Dec 2001" "ACE" \" -*- nroff -*-
.ad l
.nh
.SH NAME
ACE_Cache_Map_Iterator \- Defines a iterator for the Cache_Map_Manager.
.SH SYNOPSIS
.br
.PP
\fC#include <Cache_Map_Manager_T.h>\fR
.PP
.SS Public Types
.in +1c
.ti -1c
.RI "typedef \fBACE_Reference_Pair\fR<KEY, VALUE> \fBvalue_type\fR"
.br
.RI "\fIThe actual value mapped to the key in the cache. The are used by the strategy and is transperant to the cache user.\fR"
.ti -1c
.RI "typedef \fBACE_Pair\fR<VALUE, ATTRIBUTES> \fBCACHE_VALUE\fR"
.br
.in -1c
.SS Public Methods
.in +1c
.ti -1c
.RI "\fBACE_Cache_Map_Iterator\fR (const IMPLEMENTATION &iterator_impl)"
.br
.ti -1c
.RI "\fBACE_Cache_Map_Iterator\fR (const ACE_Cache_Map_Iterator<KEY, VALUE, IMPLEMENTATION, CACHING_STRATEGY, ATTRIBUTES> &rhs)"
.br
.RI "\fICopy constructor.\fR"
.ti -1c
.RI "virtual \fB~ACE_Cache_Map_Iterator\fR (void)"
.br
.ti -1c
.RI "ACE_Cache_Map_Iterator<KEY, VALUE, IMPLEMENTATION, CACHING_STRATEGY, ATTRIBUTES>& \fBoperator=\fR (const ACE_Cache_Map_Iterator<KEY, VALUE, IMPLEMENTATION, CACHING_STRATEGY, ATTRIBUTES> &rhs)"
.br
.RI "\fIassignment operator.\fR"
.ti -1c
.RI "int \fBoperator==\fR (const ACE_Cache_Map_Iterator<KEY, VALUE, IMPLEMENTATION, CACHING_STRATEGY, ATTRIBUTES> &rhs) const"
.br
.RI "\fIComparision operators.\fR"
.ti -1c
.RI "int \fBoperator!=\fR (const ACE_Cache_Map_Iterator<KEY, VALUE, IMPLEMENTATION, CACHING_STRATEGY, ATTRIBUTES> &rhs) const"
.br
.ti -1c
.RI "\fBACE_Reference_Pair\fR<KEY, VALUE> \fBoperator *\fR (void) const"
.br
.RI "\fIReturns a reference to the internal element <this> is pointing to.\fR"
.ti -1c
.RI "ACE_Cache_Map_Iterator<KEY, VALUE, IMPLEMENTATION, CACHING_STRATEGY, ATTRIBUTES>& \fBoperator++\fR (void)"
.br
.RI "\fIPrefix advance.\fR"
.ti -1c
.RI "ACE_Cache_Map_Iterator<KEY, VALUE, IMPLEMENTATION, CACHING_STRATEGY, ATTRIBUTES> \fBoperator++\fR (int)"
.br
.RI "\fIPostfix advance.\fR"
.ti -1c
.RI "ACE_Cache_Map_Iterator<KEY, VALUE, IMPLEMENTATION, CACHING_STRATEGY, ATTRIBUTES>& \fBoperator--\fR (void)"
.br
.RI "\fIPrefix reverse.\fR"
.ti -1c
.RI "ACE_Cache_Map_Iterator<KEY, VALUE, IMPLEMENTATION, CACHING_STRATEGY, ATTRIBUTES> \fBoperator--\fR (int)"
.br
.RI "\fIPostfix reverse.\fR"
.ti -1c
.RI "IMPLEMENTATION& \fBiterator_implementation\fR (void)"
.br
.RI "\fIReturns the iterator of the internal map in the custody of the Cache_Map_Manager.\fR"
.ti -1c
.RI "void \fBdump\fR (void) const"
.br
.RI "\fIDump the state of an object.\fR"
.in -1c
.SS Public Attributes
.in +1c
.ti -1c
.RI "\fBACE_ALLOC_HOOK_DECLARE\fR"
.br
.RI "\fIDeclare the dynamic allocation hooks.\fR"
.in -1c
.SS Protected Attributes
.in +1c
.ti -1c
.RI "IMPLEMENTATION \fBiterator_implementation_\fR"
.br
.RI "\fIThe actual iterator which iterates internally on the map belonging to the Cache_Map_Manager.\fR"
.in -1c
.SH DETAILED DESCRIPTION
.PP
.SS template<class KEY, class VALUE, class IMPLEMENTATION, class CACHING_STRATEGY, class ATTRIBUTES> template class ACE_Cache_Map_Iterator
Defines a iterator for the Cache_Map_Manager.
.PP
.PP
Implementation to be provided by the iterator of the map managed by the \fBACE_Cache_Map_Manager\fR.
.PP
.SH MEMBER TYPEDEF DOCUMENTATION
.PP
.SS template<classKEY, classVALUE, classIMPLEMENTATION, classCACHING_STRATEGY, classATTRIBUTES> typedef \fBACE_Pair\fR<VALUE, ATTRIBUTES> ACE_Cache_Map_Iterator<KEY, VALUE, IMPLEMENTATION, CACHING_STRATEGY, ATTRIBUTES>::CACHE_VALUE
.PP
.SS template<classKEY, classVALUE, classIMPLEMENTATION, classCACHING_STRATEGY, classATTRIBUTES> typedef \fBACE_Reference_Pair\fR<KEY, VALUE> ACE_Cache_Map_Iterator<KEY, VALUE, IMPLEMENTATION, CACHING_STRATEGY, ATTRIBUTES>::value_type
.PP
The actual value mapped to the key in the cache. The are used by the strategy and is transperant to the cache user.
.PP
.SH CONSTRUCTOR & DESTRUCTOR DOCUMENTATION
.PP
.SS template<classKEY, classVALUE, classIMPLEMENTATION, classCACHING_STRATEGY, classATTRIBUTES> ACE_Cache_Map_Iterator<KEY, VALUE, IMPLEMENTATION, CACHING_STRATEGY, ATTRIBUTES>::ACE_Cache_Map_Iterator<KEY, VALUE, IMPLEMENTATION, CACHING_STRATEGY, ATTRIBUTES> (const IMPLEMENTATION & iterator_impl)
.PP
.SS template<classKEY, classVALUE, classIMPLEMENTATION, classCACHING_STRATEGY, classATTRIBUTES> ACE_Cache_Map_Iterator<KEY, VALUE, IMPLEMENTATION, CACHING_STRATEGY, ATTRIBUTES>::ACE_Cache_Map_Iterator<KEY, VALUE, IMPLEMENTATION, CACHING_STRATEGY, ATTRIBUTES> (const ACE_Cache_Map_Iterator< KEY,VALUE,IMPLEMENTATION,CACHING_STRATEGY,ATTRIBUTES >& rhs)
.PP
Copy constructor.
.PP
.SS template<classKEY, classVALUE, classIMPLEMENTATION, classCACHING_STRATEGY, classATTRIBUTES> virtual ACE_Cache_Map_Iterator<KEY, VALUE, IMPLEMENTATION, CACHING_STRATEGY, ATTRIBUTES>::~ACE_Cache_Map_Iterator<KEY, VALUE, IMPLEMENTATION, CACHING_STRATEGY, ATTRIBUTES> (void)\fC [virtual]\fR
.PP
.SH MEMBER FUNCTION DOCUMENTATION
.PP
.SS template<classKEY, classVALUE, classIMPLEMENTATION, classCACHING_STRATEGY, classATTRIBUTES> void ACE_Cache_Map_Iterator<KEY, VALUE, IMPLEMENTATION, CACHING_STRATEGY, ATTRIBUTES>::dump (void) const
.PP
Dump the state of an object.
.PP
.SS template<classKEY, classVALUE, classIMPLEMENTATION, classCACHING_STRATEGY, classATTRIBUTES> IMPLEMENTATION & ACE_Cache_Map_Iterator<KEY, VALUE, IMPLEMENTATION, CACHING_STRATEGY, ATTRIBUTES>::iterator_implementation (void)
.PP
Returns the iterator of the internal map in the custody of the Cache_Map_Manager.
.PP
.SS template<classKEY, classVALUE, classIMPLEMENTATION, classCACHING_STRATEGY, classATTRIBUTES> \fBACE_Reference_Pair\fR< KEY,VALUE > ACE_Cache_Map_Iterator<KEY, VALUE, IMPLEMENTATION, CACHING_STRATEGY, ATTRIBUTES>::operator * (void) const
.PP
Returns a reference to the internal element <this> is pointing to.
.PP
.SS template<classKEY, classVALUE, classIMPLEMENTATION, classCACHING_STRATEGY, classATTRIBUTES> int ACE_Cache_Map_Iterator<KEY, VALUE, IMPLEMENTATION, CACHING_STRATEGY, ATTRIBUTES>::operator!= (const ACE_Cache_Map_Iterator< KEY,VALUE,IMPLEMENTATION,CACHING_STRATEGY,ATTRIBUTES >& rhs) const
.PP
.SS template<classKEY, classVALUE, classIMPLEMENTATION, classCACHING_STRATEGY, classATTRIBUTES> ACE_Cache_Map_Iterator< KEY,VALUE,IMPLEMENTATION,CACHING_STRATEGY,ATTRIBUTES > ACE_Cache_Map_Iterator<KEY, VALUE, IMPLEMENTATION, CACHING_STRATEGY, ATTRIBUTES>::operator++ (int)
.PP
Postfix advance.
.PP
.SS template<classKEY, classVALUE, classIMPLEMENTATION, classCACHING_STRATEGY, classATTRIBUTES> ACE_Cache_Map_Iterator< KEY,VALUE,IMPLEMENTATION,CACHING_STRATEGY,ATTRIBUTES >& ACE_Cache_Map_Iterator<KEY, VALUE, IMPLEMENTATION, CACHING_STRATEGY, ATTRIBUTES>::operator++ (void)
.PP
Prefix advance.
.PP
.SS template<classKEY, classVALUE, classIMPLEMENTATION, classCACHING_STRATEGY, classATTRIBUTES> ACE_Cache_Map_Iterator< KEY,VALUE,IMPLEMENTATION,CACHING_STRATEGY,ATTRIBUTES > ACE_Cache_Map_Iterator<KEY, VALUE, IMPLEMENTATION, CACHING_STRATEGY, ATTRIBUTES>::operator-- (int)
.PP
Postfix reverse.
.PP
.SS template<classKEY, classVALUE, classIMPLEMENTATION, classCACHING_STRATEGY, classATTRIBUTES> ACE_Cache_Map_Iterator< KEY,VALUE,IMPLEMENTATION,CACHING_STRATEGY,ATTRIBUTES >& ACE_Cache_Map_Iterator<KEY, VALUE, IMPLEMENTATION, CACHING_STRATEGY, ATTRIBUTES>::operator-- (void)
.PP
Prefix reverse.
.PP
.SS template<classKEY, classVALUE, classIMPLEMENTATION, classCACHING_STRATEGY, classATTRIBUTES> 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)
.PP
assignment operator.
.PP
.SS template<classKEY, classVALUE, classIMPLEMENTATION, classCACHING_STRATEGY, classATTRIBUTES> int ACE_Cache_Map_Iterator<KEY, VALUE, IMPLEMENTATION, CACHING_STRATEGY, ATTRIBUTES>::operator== (const ACE_Cache_Map_Iterator< KEY,VALUE,IMPLEMENTATION,CACHING_STRATEGY,ATTRIBUTES >& rhs) const
.PP
Comparision operators.
.PP
.SH MEMBER DATA DOCUMENTATION
.PP
.SS template<classKEY, classVALUE, classIMPLEMENTATION, classCACHING_STRATEGY, classATTRIBUTES> ACE_Cache_Map_Iterator<KEY, VALUE, IMPLEMENTATION, CACHING_STRATEGY, ATTRIBUTES>::ACE_ALLOC_HOOK_DECLARE
.PP
Declare the dynamic allocation hooks.
.PP
.SS template<classKEY, classVALUE, classIMPLEMENTATION, classCACHING_STRATEGY, classATTRIBUTES> IMPLEMENTATION ACE_Cache_Map_Iterator<KEY, VALUE, IMPLEMENTATION, CACHING_STRATEGY, ATTRIBUTES>::iterator_implementation_\fC [protected]\fR
.PP
The actual iterator which iterates internally on the map belonging to the Cache_Map_Manager.
.PP
.SH AUTHOR
.PP
Generated automatically by Doxygen for ACE from the source code.
|