mongo::BasicCursor Class Reference

#include <cursor.h>

Inheritance diagram for mongo::BasicCursor:

[legend]

List of all members.

Public Member Functions
Record *	_current ()
bool	advance ()
	BasicCursor (const AdvanceStrategy *_s=forward())
	BasicCursor (DiskLoc dl, const AdvanceStrategy *_s=forward())
BSONObj	current ()
virtual DiskLoc	currLoc ()
virtual bool	getsetdup (DiskLoc loc)
virtual bool	isMultiKey () const
virtual CoveredIndexMatcher *	matcher () const
virtual bool	modifiedKeys () const
virtual long long	nscanned ()
bool	ok ()
virtual DiskLoc	refLoc ()
virtual void	setMatcher (shared_ptr< CoveredIndexMatcher > matcher)
virtual void	setTailable ()
virtual bool	supportGetMore ()
virtual bool	supportYields ()
virtual bool	tailable ()
virtual string	toString ()
Protected Member Functions
void	incNscanned ()
Protected Attributes
DiskLoc	curr
DiskLoc	last
const AdvanceStrategy *	s
Private Member Functions
void	init ()
Private Attributes
shared_ptr< CoveredIndexMatcher >	_matcher
long long	_nscanned
bool	tailable_

---

Detailed Description

Definition at line 137 of file cursor.h.

---

Constructor & Destructor Documentation

mongo::BasicCursor::BasicCursor	(	DiskLoc	dl,
		const AdvanceStrategy *	_s = forward()
	)			[inline]

Definition at line 139 of file cursor.h.

mongo::BasicCursor::BasicCursor

(

const AdvanceStrategy *

_s = forward()

)

[inline]

Definition at line 143 of file cursor.h.

---

Member Function Documentation

Record* mongo::BasicCursor::_current

(

)

[inline, virtual]

Implements mongo::Cursor.

Definition at line 147 of file cursor.h.

bool mongo::BasicCursor::advance

(

)

[virtual]

Implements mongo::Cursor.

BSONObj mongo::BasicCursor::current

(

)

[inline, virtual]

Implements mongo::Cursor.

Definition at line 151 of file cursor.h.

virtual DiskLoc mongo::BasicCursor::currLoc

(

)

[inline, virtual]

Implements mongo::Cursor.

Definition at line 156 of file cursor.h.

virtual bool mongo::BasicCursor::getsetdup

(

DiskLoc

loc

)

[inline, virtual]

Implements mongo::Cursor.

Definition at line 165 of file cursor.h.

void mongo::BasicCursor::incNscanned

(

)

[inline, protected]

Definition at line 177 of file cursor.h.

void mongo::BasicCursor::init

(

)

[inline, private]

Definition at line 182 of file cursor.h.

virtual bool mongo::BasicCursor::isMultiKey

(

)

const [inline, virtual]

Implements mongo::Cursor.

Definition at line 166 of file cursor.h.

virtual CoveredIndexMatcher* mongo::BasicCursor::matcher

(

)

const [inline, virtual]

Reimplemented from mongo::Cursor.

Definition at line 170 of file cursor.h.

virtual bool mongo::BasicCursor::modifiedKeys

(

)

const [inline, virtual]

return true if the keys in the index have been modified from the main doc if you have { a : 1 , b : [ 1 , 2 ] } an index on { a : 1 } would not be modified an index on { b : 1 } would be since the values of the array are put in the index not the array

Implements mongo::Cursor.

Definition at line 167 of file cursor.h.

virtual long long mongo::BasicCursor::nscanned

(

)

[inline, virtual]

Implements mongo::Cursor.

Definition at line 172 of file cursor.h.

bool mongo::BasicCursor::ok

(

)

[inline, virtual]

Implements mongo::Cursor.

Definition at line 146 of file cursor.h.

virtual DiskLoc mongo::BasicCursor::refLoc

(

)

[inline, virtual]

Implements mongo::Cursor.

Definition at line 157 of file cursor.h.

virtual void mongo::BasicCursor::setMatcher

(

shared_ptr< CoveredIndexMatcher >

matcher

)

[inline, virtual]

Reimplemented from mongo::Cursor.

Definition at line 171 of file cursor.h.

virtual void mongo::BasicCursor::setTailable

(

)

[inline, virtual]

Reimplemented from mongo::Cursor.

Definition at line 160 of file cursor.h.

virtual bool mongo::BasicCursor::supportGetMore

(

)

[inline, virtual]

Implements mongo::Cursor.

Definition at line 168 of file cursor.h.

virtual bool mongo::BasicCursor::supportYields

(

)

[inline, virtual]

Implements mongo::Cursor.

Definition at line 169 of file cursor.h.

virtual bool mongo::BasicCursor::tailable

(

)

[inline, virtual]

Reimplemented from mongo::Cursor.

Definition at line 164 of file cursor.h.

virtual string mongo::BasicCursor::toString

(

)

[inline, virtual]

Reimplemented from mongo::Cursor.

Reimplemented in mongo::ReverseCursor, mongo::ForwardCappedCursor, and mongo::ReverseCappedCursor.

Definition at line 159 of file cursor.h.

---

Member Data Documentation

shared_ptr< CoveredIndexMatcher > mongo::BasicCursor::_matcher [private]

Definition at line 180 of file cursor.h.

long long mongo::BasicCursor::_nscanned [private]

Definition at line 181 of file cursor.h.

DiskLoc mongo::BasicCursor::curr [protected]

Definition at line 175 of file cursor.h.

DiskLoc mongo::BasicCursor::last [protected]

Definition at line 175 of file cursor.h.

const AdvanceStrategy* mongo::BasicCursor::s [protected]

Definition at line 176 of file cursor.h.

bool mongo::BasicCursor::tailable_ [private]

Definition at line 179 of file cursor.h.

---

The documentation for this class was generated from the following file:

• cursor.h