xtd::collections::generic::enumerator< type_t > Struct Template Reference

Inheritance diagram for xtd::collections::generic::enumerator< type_t >:

Definition

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

Supports a simple iteration over a generic collection.

Definition

template<typename type_t>
struct enumerator : ienumerator<type_t>;

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>.

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
	object ()=default
	Create a new instance of the ultimate base class object.
virtual auto	equals (const object &obj) const noexcept -> bool
	Determines whether the specified object is equal to the current object.
virtual auto	get_hash_code () const noexcept -> xtd::usize
	Serves as a hash function for a particular type.
virtual auto	get_type () const noexcept -> type_object
	Gets the type of the current instance.
template<typename object_t>
auto	memberwise_clone () const -> xtd::unique_ptr_object< object_t >
	Creates a shallow copy of the current object.
virtual auto	to_string () const -> xtd::string
	Returns a xtd::string that represents the current object.
template<typename object_a_t, typename object_b_t>
static auto	equals (const object_a_t &object_a, const object_b_t &object_b) noexcept -> bool
	Determines whether the specified object instances are considered equal.
template<typename object_a_t, typename object_b_t>
static auto	reference_equals (const object_a_t &object_a, const object_b_t &object_b) noexcept -> bool
	Determines whether the specified object instances are the same instance.

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

enumerator

The 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

inlinenodiscardoverridevirtual

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 >.

move_next()

template<typename type_t>

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

inlinenodiscardoverridevirtual

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_exception

The collection was modified after the enumerator was created.

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

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_exception	The collection was modified after the enumerator was created.
xtd::not_supported_exception	The enumerator does not support being reset.

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

---

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

• xtd.core/include/xtd/collections/generic/enumerator.hpp