Simias::Storage::Collection::NodeEnumerator Class Reference

Enumerator class for the node object that allows enumeration of specified node objects within the collection. More...

Inheritance diagram for Simias::Storage::Collection::NodeEnumerator:

Collaboration diagram for Simias::Storage::Collection::NodeEnumerator:

List of all members.

Public Member Functions

NodeEnumerator (Collection collection, Property property, SearchOp queryOperator)

Constructor for the NodeEnumerator object.

void Reset ()

Sets the enumerator to its initial position, which is before the first element in the collection.

bool MoveNext ()

Advances the enumerator to the next element of the collection.

bool SetCursor (IndexOrigin origin, int offset)

Set the cursor for the current search to the specified index.

void Dispose ()

Allows for quick release of managed and unmanaged resources. Called by applications.

Protected Member Functions

virtual void Dispose (bool disposing)

Dispose( bool disposing ) executes in two distinct scenarios. If disposing equals true, the method has been called directly or indirectly by a user's code. Managed and unmanaged resources can be disposed. If disposing equals false, the method has been called by the runtime from inside the finalizer and you should not reference other objects. Only unmanaged resources can be disposed.

Properties

int Count [get]

Gets the total number of objects contained in the search.

object Current [get]

Gets the current element in the collection.

Detailed Description

Enumerator class for the node object that allows enumeration of specified node objects within the collection.

Constructor & Destructor Documentation

Simias::Storage::Collection::NodeEnumerator::NodeEnumerator	(	Collection	collection,
		Property	property,
		SearchOp	queryOperator
	)			`[inline]`

Constructor for the NodeEnumerator object.

Parameters:

	collection	Collection object that this enumerator belongs to.
	property	Property object containing the data to search for.
	queryOperator	Query operator to use when comparing value.

Member Function Documentation

void Simias::Storage::Collection::NodeEnumerator::Reset ( ) [inline]

Sets the enumerator to its initial position, which is before the first element in the collection.

bool Simias::Storage::Collection::NodeEnumerator::MoveNext ( ) [inline]

Advances the enumerator to the next element of the collection.

Returns:: true if the enumerator was successfully advanced to the next element; false if the enumerator has passed the end of the collection.

bool Simias::Storage::Collection::NodeEnumerator::SetCursor	(	IndexOrigin	origin,
		int	offset
	)			`[inline]`

Set the cursor for the current search to the specified index.

Parameters:

	origin	The origin to move from.
	offset	The offset to move the index by.

Returns:: True if successful, otherwise false is returned.

Implements Simias::Storage::ICSEnumerator.

void Simias::Storage::Collection::NodeEnumerator::Dispose ( ) [inline]

Allows for quick release of managed and unmanaged resources. Called by applications.

virtual void Simias::Storage::Collection::NodeEnumerator::Dispose ( bool disposing ) [inline, protected, virtual]

Dispose( bool disposing ) executes in two distinct scenarios. If disposing equals true, the method has been called directly or indirectly by a user's code. Managed and unmanaged resources can be disposed. If disposing equals false, the method has been called by the runtime from inside the finalizer and you should not reference other objects. Only unmanaged resources can be disposed.

Parameters:

disposing

Specifies whether called from the finalizer or from the application.

Property Documentation

int Simias::Storage::Collection::NodeEnumerator::Count [get]

Gets the total number of objects contained in the search.

Implements Simias::Storage::ICSEnumerator.

object Simias::Storage::Collection::NodeEnumerator::Current [get]

Gets the current element in the collection.

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

src/core/CollectionStore/Collection.cs


Public Member Functions
	NodeEnumerator (Collection collection, Property property, SearchOp queryOperator)
	Constructor for the NodeEnumerator object.
void	Reset ()
	Sets the enumerator to its initial position, which is before the first element in the collection.
bool	MoveNext ()
	Advances the enumerator to the next element of the collection.
bool	SetCursor (IndexOrigin origin, int offset)
	Set the cursor for the current search to the specified index.
void	Dispose ()
	Allows for quick release of managed and unmanaged resources. Called by applications.
Protected Member Functions
virtual void	Dispose (bool disposing)
	Dispose( bool disposing ) executes in two distinct scenarios. If disposing equals true, the method has been called directly or indirectly by a user's code. Managed and unmanaged resources can be disposed. If disposing equals false, the method has been called by the runtime from inside the finalizer and you should not reference other objects. Only unmanaged resources can be disposed.
Properties
int	Count `[get]`
	Gets the total number of objects contained in the search.
object	Current `[get]`
	Gets the current element in the collection.