.TH "ost::MapIndex" 3 "Sun Dec 27 2020" "GNU CommonC++" \" -*- nroff -*-
.ad l
.nh
.SH NAME
ost::MapIndex \- The \fBMapIndex\fP allows linear access into a \fBMapTable\fP, that otherwise could have its elements being retrieved only by key\&.  

.SH SYNOPSIS
.br
.PP
.PP
\fC#include <object\&.h>\fP
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBMapIndex\fP ()"
.br
.RI "Creates an empty map index (pointing to nothing)\&. "
.ti -1c
.RI "\fBMapIndex\fP (\fBMapObject\fP *theObject)"
.br
.RI "Creates a map index pointing to a specific map object\&. "
.ti -1c
.RI "\fBMapIndex\fP (const \fBMapIndex\fP &theIndex)"
.br
.RI "Creates a copy of a given map index\&. "
.ti -1c
.RI "void * \fBoperator*\fP () const"
.br
.RI "Dereference operator: the pointed object it is returned as void * for easy re-cast\&. "
.ti -1c
.RI "\fBMapIndex\fP & \fBoperator=\fP (\fBMapObject\fP *theObject)"
.br
.RI "Assignment operator to avoid implicit cast\&. "
.ti -1c
.RI "\fBMapIndex\fP & \fBoperator++\fP ()"
.br
.RI "Prefix increment operator, to be used in loops and such\&. "
.ti -1c
.RI "\fBMapIndex\fP \fBoperator++\fP (int)"
.br
.RI "Postfix increment operator, to be used in loops and such\&. "
.ti -1c
.RI "bool \fBoperator==\fP (const \fBMapIndex\fP &theIndex) const"
.br
.RI "Comparison operator, between two \fBMapIndex\fP's\&. "
.ti -1c
.RI "bool \fBoperator!=\fP (const \fBMapIndex\fP &theIndex) const"
.br
.ti -1c
.RI "bool \fBoperator==\fP (const \fBMapObject\fP *theObject) const"
.br
.RI "Comparison operator, between the \fBMapIndex\fP and a \fBMapObject\fP, useful to avoid casts for sake of clearness\&. "
.ti -1c
.RI "bool \fBoperator!=\fP (const \fBMapObject\fP *theObject) const"
.br
.in -1c
.SH "Detailed Description"
.PP 
The \fBMapIndex\fP allows linear access into a \fBMapTable\fP, that otherwise could have its elements being retrieved only by key\&. 

It can be increased, checked and dereferenced like a pointer, by means of suitable operators\&.
.PP
\fBAuthor\fP
.RS 4
Sergio Repetto s.repetto@pentaengineering.it
.RE
.PP
Index object to access \fBMapTable\fP elements 
.SH "Constructor & Destructor Documentation"
.PP 
.SS "ost::MapIndex::MapIndex ()\fC [inline]\fP"

.PP
Creates an empty map index (pointing to nothing)\&. 
.SS "ost::MapIndex::MapIndex (\fBMapObject\fP * theObject)\fC [inline]\fP"

.PP
Creates a map index pointing to a specific map object\&. 
.PP
\fBParameters\fP
.RS 4
\fIthe\fP indexed object 
.RE
.PP

.SS "ost::MapIndex::MapIndex (const \fBMapIndex\fP & theIndex)\fC [inline]\fP"

.PP
Creates a copy of a given map index\&. 
.PP
\fBParameters\fP
.RS 4
\fIthe\fP source index object 
.RE
.PP

.SH "Member Function Documentation"
.PP 
.SS "bool ost::MapIndex::operator!= (const \fBMapIndex\fP & theIndex) const\fC [inline]\fP"

.SS "bool ost::MapIndex::operator!= (const \fBMapObject\fP * theObject) const\fC [inline]\fP"

.SS "void* ost::MapIndex::operator* () const\fC [inline]\fP"

.PP
Dereference operator: the pointed object it is returned as void * for easy re-cast\&. 
.PP
\fBReturns\fP
.RS 4
pointer to indexed object\&. 
.RE
.PP

.SS "\fBMapIndex\fP& ost::MapIndex::operator++ ()"

.PP
Prefix increment operator, to be used in loops and such\&. 
.PP
\fBReturns\fP
.RS 4
the object itself, as changed\&. 
.RE
.PP

.SS "\fBMapIndex\fP ost::MapIndex::operator++ (int)\fC [inline]\fP"

.PP
Postfix increment operator, to be used in loops and such\&. 
.PP
\fBReturns\fP
.RS 4
the object itself, as changed\&. 
.RE
.PP

.SS "\fBMapIndex\fP& ost::MapIndex::operator= (\fBMapObject\fP * theObject)"

.PP
Assignment operator to avoid implicit cast\&. 
.PP
\fBReturns\fP
.RS 4
the object itself, as changed\&. 
.RE
.PP

.SS "bool ost::MapIndex::operator== (const \fBMapIndex\fP & theIndex) const\fC [inline]\fP"

.PP
Comparison operator, between two \fBMapIndex\fP's\&. 
.PP
\fBReturns\fP
.RS 4
the object itself, as changed\&. 
.RE
.PP

.SS "bool ost::MapIndex::operator== (const \fBMapObject\fP * theObject) const\fC [inline]\fP"

.PP
Comparison operator, between the \fBMapIndex\fP and a \fBMapObject\fP, useful to avoid casts for sake of clearness\&. 
.PP
\fBReturns\fP
.RS 4
the object itself, as changed\&. 
.RE
.PP


.SH "Author"
.PP 
Generated automatically by Doxygen for GNU CommonC++ from the source code\&.