xtd 0.2.0
Loading...
Searching...
No Matches
xtd::collections::generic::enumerator< type_t > Class Template Reference
Inheritance diagram for xtd::collections::generic::enumerator< type_t >:
xtd::collections::generic::ienumerator< type_t > xtd::interface

Definition

template<typename type_t>
class xtd::collections::generic::enumerator< type_t >

Supports a simple iteration over a generic collection.

Definition
template<typename type_t>
Supports a simple iteration over a generic collection.
Definition enumerator.h:31
#define interface_
This keyword is use to represent an interface.
Definition interface.h:58
Header
#include <xtd/collections/enumerator
Namespace
xtd::collections::generic
Library
xtd.core
Remarks
The xtd::collections::generic::enumerator <type_t> class is used to encapsulate an xtd::collections::generic::ienumerator <type_t>.
Examples
generic_icollection.cpp, generic_ienumerable.cpp, generic_ienumerable2.cpp, generic_ienumerator.cpp, generic_ilist.cpp, ienumerable.cpp, ienumerator.cpp, and ilist.cpp.

Public Constructors

 enumerator ()=default
 Initializes a new instance of the xtd::collections::generic::enumerator <type_t> class.
 
 enumerator (ptr< ienumerator< type_t > > enumerator)
 Initializes a new instance of the xtd::collections::generic::enumerator <type_t> class with specified enumerator.
 

Public Properties

const type_t & current () const override
 Gets the element in the collection at the current position of the enumerator.
 

Public Methods

bool move_next () override
 Advances the enumerator to the next element of the collection.
 
void reset () override
 Sets the enumerator to its initial position, which is before the first element in the collection.
 

Additional Inherited Members

- Public Member Functions inherited from xtd::collections::generic::ienumerator< type_t >

Constructor & Destructor Documentation

◆ enumerator() [1/2]

template<typename type_t >
xtd::collections::generic::enumerator< type_t >::enumerator ( )
default

Initializes a new instance of the xtd::collections::generic::enumerator <type_t> class.

◆ enumerator() [2/2]

template<typename type_t >
xtd::collections::generic::enumerator< type_t >::enumerator ( ptr< ienumerator< type_t > >  enumerator)
inline

Initializes a new instance of the xtd::collections::generic::enumerator <type_t> class with specified enumerator.

Parameters
enumeratorThe xtd::collections::generic::ienumerator <type_t> enumerator to encapsulate.

Member Function Documentation

◆ current()

template<typename type_t >
const type_t & xtd::collections::generic::enumerator< type_t >::current ( ) const
inlineoverridevirtual

Gets the element in the collection at the current position of the enumerator.

Returns
The element in the collection at the current position of the enumerator.

Implements xtd::collections::generic::ienumerator< type_t >.

Examples
generic_ienumerable2.cpp, generic_ienumerator.cpp, and ienumerator.cpp.

◆ move_next()

template<typename type_t >
bool xtd::collections::generic::enumerator< type_t >::move_next ( )
inlineoverridevirtual

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.
Exceptions
xtd::invalid_operation_exceptionThe collection was modified after the enumerator was created.

Implements xtd::collections::generic::ienumerator< type_t >.

Examples
generic_ienumerable2.cpp, generic_ienumerator.cpp, and ienumerator.cpp.

◆ reset()

template<typename type_t >
void xtd::collections::generic::enumerator< type_t >::reset ( )
inlineoverridevirtual

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

Exceptions
xtd::invalid_operation_exceptionThe collection was modified after the enumerator was created.
xtd::not_supported_exceptionThe enumerator does not support being reset.

Implements xtd::collections::generic::ienumerator< type_t >.


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