PLCnext API Documentation 25.0.2.69
Public Member Functions | Friends | List of all members
Arp::System::Commons::Io::Directory::Enumerator< Iterator > Class Template Reference
Inheritance diagram for Arp::System::Commons::Io::Directory::Enumerator< Iterator >:
Inheritance graph

Public Member Functions

bool MoveNext (void) override
 Moves this enumerator to the next position. More...
 
String GetCurrent (void) override
 Gets the element at the current position. More...
 
- Public Member Functions inherited from Arp::Base::Core::IEnumerator< T >
 IEnumerator (void)=default
 Constructs an IEnumerator instance.
 
 IEnumerator (const IEnumerator &arg)=default
 Deleted copy constructor.
 
 IEnumerator (IEnumerator &&arg) noexcept=default
 Move constructor.
 
IEnumeratoroperator= (const IEnumerator &arg)=default
 Deleted copy-assignment IEnumerator.
 
IEnumeratoroperator= (IEnumerator &&arg) noexcept=default
 Move-assignment operator.
 
virtual ~IEnumerator (void)=default
 Destructs this instance and frees all resources.
 
virtual bool MoveNext (void)=0
 Moves this enumerator to the next position. More...
 
virtual T GetCurrent (void)=0
 Gets the element at the current position. More...
 

Friends

class Directory
 

Additional Inherited Members

- Public Types inherited from Arp::Base::Core::IEnumerator< T >
using Ptr = std::shared_ptr< IEnumerator >
 The smart pointer type of this interface.
 
using ValueType = T
 Type of the enumerated values
 

Member Function Documentation

◆ GetCurrent()

template<class Iterator >
String Arp::System::Commons::Io::Directory::Enumerator< Iterator >::GetCurrent ( void  )
inlineoverridevirtual

Gets the element at the current position.

Returns
The element at the current position.

Depending on the template parameter type of this interface, a reference or even const reference might be returned.

Exceptions
InvalidOperationExceptionWhen GetCurrent() is called before MoveNext() or after MoveNext() has returned false once.

Implements Arp::Base::Core::IEnumerator< T >.

◆ MoveNext()

template<class Iterator >
bool Arp::System::Commons::Io::Directory::Enumerator< Iterator >::MoveNext ( void  )
inlineoverridevirtual

Moves this enumerator to the next position.

Returns
false if the end of the container/collections/enumeration has reached, otherwise true.
See also
IEnumerator

Implements Arp::Base::Core::IEnumerator< T >.


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