File: ACE_Unbounded_Set_Const_Iterator.3

package info (click to toggle)
ace 5.2.1-1
  • links: PTS
  • area: main
  • in suites: woody
  • size: 26,856 kB
  • ctags: 18,677
  • sloc: cpp: 171,831; makefile: 48,840; sh: 10,192; perl: 8,582; exp: 787; yacc: 387; lex: 140; csh: 20
file content (145 lines) | stat: -rw-r--r-- 4,535 bytes parent folder | download
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
.TH ACE_Unbounded_Set_Const_Iterator 3 "1 Dec 2001" "ACE" \" -*- nroff -*-
.ad l
.nh
.SH NAME
ACE_Unbounded_Set_Const_Iterator \- Implement an const iterator over an unbounded set. 
.SH SYNOPSIS
.br
.PP
\fC#include <Unbounded_Set.h>\fR
.PP
.SS Public Methods

.in +1c
.ti -1c
.RI "\fBACE_Unbounded_Set_Const_Iterator\fR (const \fBACE_Unbounded_Set\fR<T> &s, int end = 0)"
.br
.ti -1c
.RI "int \fBnext\fR (T *&next_item)"
.br
.RI "\fIPass back the <next_item> that hasn't been seen in the Set. Returns 0 when all items have been seen, else 1.\fR"
.ti -1c
.RI "int \fBadvance\fR (void)"
.br
.RI "\fIMove forward by one element in the set. Returns 0 when all the items in the set have been seen, else 1.\fR"
.ti -1c
.RI "int \fBfirst\fR (void)"
.br
.RI "\fIMove to the first element in the set. Returns 0 if the set is empty, 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 "void \fBdump\fR (void) const"
.br
.RI "\fIDump the state of an object.\fR"
.ti -1c
.RI "ACE_Unbounded_Set_Const_Iterator<T> \fBoperator++\fR (int)"
.br
.RI "\fIPostfix advance.\fR"
.ti -1c
.RI "ACE_Unbounded_Set_Const_Iterator<T>& \fBoperator++\fR (void)"
.br
.RI "\fIPrefix advance.\fR"
.ti -1c
.RI "T& \fBoperator *\fR (void)"
.br
.RI "\fIReturns a reference to the internal element <this> is pointing to.\fR"
.ti -1c
.RI "int \fBoperator==\fR (const ACE_Unbounded_Set_Const_Iterator<T> &) const"
.br
.RI "\fICheck if two iterators point to the same position.\fR"
.ti -1c
.RI "int \fBoperator!=\fR (const ACE_Unbounded_Set_Const_Iterator<T> &) 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 Private Attributes

.in +1c
.ti -1c
.RI "\fBACE_Node\fR<T>* \fBcurrent_\fR"
.br
.RI "\fIPointer to the current node in the iteration.\fR"
.ti -1c
.RI "const \fBACE_Unbounded_Set\fR<T>* \fBset_\fR"
.br
.RI "\fIPointer to the set we're iterating over.\fR"
.in -1c
.SH DETAILED DESCRIPTION
.PP 

.SS template<class T>  template class ACE_Unbounded_Set_Const_Iterator
Implement an const iterator over an unbounded set.
.PP
.SH CONSTRUCTOR & DESTRUCTOR DOCUMENTATION
.PP 
.SS template<classT> ACE_Unbounded_Set_Const_Iterator<T>::ACE_Unbounded_Set_Const_Iterator<T> (const \fBACE_Unbounded_Set\fR< T >& s, int end = 0)
.PP
.SH MEMBER FUNCTION DOCUMENTATION
.PP 
.SS template<classT> int ACE_Unbounded_Set_Const_Iterator<T>::advance (void)
.PP
Move forward by one element in the set. Returns 0 when all the items in the set have been seen, else 1.
.PP
.SS template<classT> int ACE_Unbounded_Set_Const_Iterator<T>::done (void) const
.PP
Returns 1 when all items have been seen, else 0.
.PP
.SS template<classT> void ACE_Unbounded_Set_Const_Iterator<T>::dump (void) const
.PP
Dump the state of an object.
.PP
.SS template<classT> int ACE_Unbounded_Set_Const_Iterator<T>::first (void)
.PP
Move to the first element in the set. Returns 0 if the set is empty, else 1.
.PP
.SS template<classT> int ACE_Unbounded_Set_Const_Iterator<T>::next (T *& next_item)
.PP
Pass back the <next_item> that hasn't been seen in the Set. Returns 0 when all items have been seen, else 1.
.PP
.SS template<classT> T & ACE_Unbounded_Set_Const_Iterator<T>::operator * (void)
.PP
Returns a reference to the internal element <this> is pointing to.
.PP
.SS template<classT> int ACE_Unbounded_Set_Const_Iterator<T>::operator!= (const ACE_Unbounded_Set_Const_Iterator< T >&) const
.PP
.SS template<classT> ACE_Unbounded_Set_Const_Iterator< T >& ACE_Unbounded_Set_Const_Iterator<T>::operator++ (void)
.PP
Prefix advance.
.PP
.SS template<classT> ACE_Unbounded_Set_Const_Iterator< T > ACE_Unbounded_Set_Const_Iterator<T>::operator++ (int)
.PP
Postfix advance.
.PP
.SS template<classT> int ACE_Unbounded_Set_Const_Iterator<T>::operator== (const ACE_Unbounded_Set_Const_Iterator< T >&) const
.PP
Check if two iterators point to the same position.
.PP
.SH MEMBER DATA DOCUMENTATION
.PP 
.SS template<classT> ACE_Unbounded_Set_Const_Iterator<T>::ACE_ALLOC_HOOK_DECLARE
.PP
Declare the dynamic allocation hooks.
.PP
.SS template<classT> \fBACE_Node\fR< T >* ACE_Unbounded_Set_Const_Iterator<T>::current_\fC [private]\fR
.PP
Pointer to the current node in the iteration.
.PP
.SS template<classT> const \fBACE_Unbounded_Set\fR< T >* ACE_Unbounded_Set_Const_Iterator<T>::set_\fC [private]\fR
.PP
Pointer to the set we're iterating over.
.PP


.SH AUTHOR
.PP 
Generated automatically by Doxygen for ACE from the source code.