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
|
.TH ACE_Map_Const_Iterator_Base 3 "1 Dec 2001" "ACE" \" -*- nroff -*-
.ad l
.nh
.SH NAME
ACE_Map_Const_Iterator_Base \- Const iterator for the .
.SH SYNOPSIS
.br
.PP
\fC#include <Map_Manager.h>\fR
.PP
Inherited by \fBACE_Map_Const_Iterator\fR.
.PP
.SS Public Methods
.in +1c
.ti -1c
.RI "\fBACE_Map_Const_Iterator_Base\fR (const \fBACE_Map_Manager\fR <EXT_ID, INT_ID, ACE_LOCK> &mm)"
.br
.RI "\fIContructor. If head != 0, the iterator constructed is positioned at the head of the map, it is positioned at the end otherwise.\fR"
.ti -1c
.RI "int \fBnext\fR (\fBACE_Map_Entry\fR<EXT_ID, INT_ID> *&next_entry) const"
.br
.RI "\fIPass back the next <entry> that hasn't been seen in the Set. Returns 0 when all items have been seen, else 1.\fR"
.ti -1c
.RI "int \fBdone\fR (void) const"
.br
.RI "\fIReturns 1 when all items have been seen, else 0.\fR"
.ti -1c
.RI "\fBACE_Map_Entry\fR<EXT_ID, INT_ID>& \fBoperator *\fR (void) const"
.br
.RI "\fIReturns a reference to the interal element <this> is pointing to.\fR"
.ti -1c
.RI "const \fBACE_Map_Manager\fR<EXT_ID, INT_ID, ACE_LOCK>& \fBmap\fR (void) const"
.br
.RI "\fIReturns reference the Map_Manager that is being iterated over.\fR"
.ti -1c
.RI "int \fBoperator==\fR (const ACE_Map_Const_Iterator_Base<EXT_ID, INT_ID, ACE_LOCK> &) const"
.br
.RI "\fICheck if two iterators point to the same position.\fR"
.ti -1c
.RI "int \fBoperator!=\fR (const ACE_Map_Const_Iterator_Base<EXT_ID, INT_ID, ACE_LOCK> &) const"
.br
.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 Methods
.in +1c
.ti -1c
.RI "int \fBforward_i\fR (void)"
.br
.RI "\fIMove forward by one element in the set. Returns 0 when there's no more item in the set after the current items, else 1.\fR"
.ti -1c
.RI "int \fBreverse_i\fR (void)"
.br
.RI "\fIMove backware by one element in the set. Returns 0 when there's no more item in the set before the current item, else 1.\fR"
.ti -1c
.RI "void \fBdump_i\fR (void) const"
.br
.RI "\fIDump the state of an object.\fR"
.in -1c
.SS Protected Attributes
.in +1c
.ti -1c
.RI "const \fBACE_Map_Manager\fR<EXT_ID, INT_ID, ACE_LOCK>* \fBmap_man_\fR"
.br
.RI "\fIMap we are iterating over.\fR"
.ti -1c
.RI "ACE_UINT32 \fBnext_\fR"
.br
.RI "\fIKeeps track of how far we've advanced...\fR"
.in -1c
.SH DETAILED DESCRIPTION
.PP
.SS template<class EXT_ID, class INT_ID, class ACE_LOCK> template class ACE_Map_Const_Iterator_Base
Const iterator for the .
.PP
.PP
This class factors out common code from its templatized subclasses.
.PP
.SH CONSTRUCTOR & DESTRUCTOR DOCUMENTATION
.PP
.SS template<classEXT_ID, classINT_ID, classACE_LOCK> ACE_Map_Const_Iterator_Base<EXT_ID, INT_ID, ACE_LOCK>::ACE_Map_Const_Iterator_Base<EXT_ID, INT_ID, ACE_LOCK> (const \fBACE_Map_Manager\fR< EXT_ID,INT_ID,ACE_LOCK >& mm)
.PP
Contructor. If head != 0, the iterator constructed is positioned at the head of the map, it is positioned at the end otherwise.
.PP
.SH MEMBER FUNCTION DOCUMENTATION
.PP
.SS template<classEXT_ID, classINT_ID, classACE_LOCK> int ACE_Map_Const_Iterator_Base<EXT_ID, INT_ID, ACE_LOCK>::done (void) const
.PP
Returns 1 when all items have been seen, else 0.
.PP
.SS template<classEXT_ID, classINT_ID, classACE_LOCK> void ACE_Map_Const_Iterator_Base<EXT_ID, INT_ID, ACE_LOCK>::dump_i (void) const\fC [protected]\fR
.PP
Dump the state of an object.
.PP
.SS template<classEXT_ID, classINT_ID, classACE_LOCK> int ACE_Map_Const_Iterator_Base<EXT_ID, INT_ID, ACE_LOCK>::forward_i (void)\fC [protected]\fR
.PP
Move forward by one element in the set. Returns 0 when there's no more item in the set after the current items, else 1.
.PP
.SS template<classEXT_ID, classINT_ID, classACE_LOCK> const \fBACE_Map_Manager\fR< EXT_ID,INT_ID,ACE_LOCK >& ACE_Map_Const_Iterator_Base<EXT_ID, INT_ID, ACE_LOCK>::map (void) const
.PP
Returns reference the Map_Manager that is being iterated over.
.PP
.SS template<classEXT_ID, classINT_ID, classACE_LOCK> int ACE_Map_Const_Iterator_Base<EXT_ID, INT_ID, ACE_LOCK>::next (\fBACE_Map_Entry\fR< EXT_ID,INT_ID >*& next_entry) const
.PP
Pass back the next <entry> that hasn't been seen in the Set. Returns 0 when all items have been seen, else 1.
.PP
.SS template<classEXT_ID, classINT_ID, classACE_LOCK> \fBACE_Map_Entry\fR< EXT_ID,INT_ID >& ACE_Map_Const_Iterator_Base<EXT_ID, INT_ID, ACE_LOCK>::operator * (void) const
.PP
Returns a reference to the interal element <this> is pointing to.
.PP
.SS template<classEXT_ID, classINT_ID, classACE_LOCK> int ACE_Map_Const_Iterator_Base<EXT_ID, INT_ID, ACE_LOCK>::operator!= (const ACE_Map_Const_Iterator_Base< EXT_ID,INT_ID,ACE_LOCK >&) const
.PP
.SS template<classEXT_ID, classINT_ID, classACE_LOCK> int ACE_Map_Const_Iterator_Base<EXT_ID, INT_ID, ACE_LOCK>::operator== (const ACE_Map_Const_Iterator_Base< EXT_ID,INT_ID,ACE_LOCK >&) const
.PP
Check if two iterators point to the same position.
.PP
.SS template<classEXT_ID, classINT_ID, classACE_LOCK> int ACE_Map_Const_Iterator_Base<EXT_ID, INT_ID, ACE_LOCK>::reverse_i (void)\fC [protected]\fR
.PP
Move backware by one element in the set. Returns 0 when there's no more item in the set before the current item, else 1.
.PP
.SH MEMBER DATA DOCUMENTATION
.PP
.SS template<classEXT_ID, classINT_ID, classACE_LOCK> ACE_Map_Const_Iterator_Base<EXT_ID, INT_ID, ACE_LOCK>::ACE_ALLOC_HOOK_DECLARE
.PP
Declare the dynamic allocation hooks.
.PP
Reimplemented in \fBACE_Map_Const_Iterator\fR.
.SS template<classEXT_ID, classINT_ID, classACE_LOCK> const \fBACE_Map_Manager\fR< EXT_ID,INT_ID,ACE_LOCK >* ACE_Map_Const_Iterator_Base<EXT_ID, INT_ID, ACE_LOCK>::map_man_\fC [protected]\fR
.PP
Map we are iterating over.
.PP
.SS template<classEXT_ID, classINT_ID, classACE_LOCK> ACE_UINT32 ACE_Map_Const_Iterator_Base<EXT_ID, INT_ID, ACE_LOCK>::next_\fC [protected]\fR
.PP
Keeps track of how far we've advanced...
.PP
.SH AUTHOR
.PP
Generated automatically by Doxygen for ACE from the source code.
|