PLCnext API Documentation 25.0.2.69
Public Member Functions | List of all members
Arp::System::Commons::Configuration::PlaceholderExpression::Enumerator Class Reference
Inheritance diagram for Arp::System::Commons::Configuration::PlaceholderExpression::Enumerator:
Inheritance graph

Public Member Functions

 Enumerator (const String &input)
 
bool MoveNext (void) override
 Moves this enumerator to the next position. More...
 
bool IsCurrentBuiltIn (void)
 
- Public Member Functions inherited from Arp::Base::Core::Enumerator< T >
 Enumerator (void)
 Constructs a default Enumerator instance.
 
 Enumerator (const Enumerator &arg)=delete
 
 Enumerator (Enumerator &&arg) noexcept
 Move constructor. More...
 
Enumeratoroperator= (const Enumerator &arg)=delete
 
Enumeratoroperator= (Enumerator &&arg) noexcept
 Move assignment operator. More...
 
 ~Enumerator (void) override
 Destructs this instance and frees all resources.
 
GetCurrent (void) override
 Gets the element at the current position. More...
 
template<class S , class O >
IEnumerator< T >::Ptr CreateTransform (std::shared_ptr< S > sourcePtr, O transformOperation)
 Creates a transforming adapter enumerating applying a transform operation to each element. 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...
 

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
 
- Static Public Member Functions inherited from Arp::Base::Core::Enumerator< T >
static IEnumerator< T >::Ptr CreateEmpty (void)
 Creates an empty enumerator. More...
 
static IEnumerator< T >::Ptr CreateComposite (typename IEnumerator< T >::Ptr first, typename IEnumerator< T >::Ptr second)
 Creates a composite enumerator from the two given enumerators, e.g. to enumerate trees easily. More...
 
template<class TIterator >
static IEnumerator< T >::Ptr CreateStlAdapter (TIterator begin, TIterator end)
 Creates an enumerator adapter from the given STL iterators. More...
 
template<class TContainer >
static IEnumerator< T >::Ptr CreateStlAdapter (TContainer &c)
 Creates an enumerator adapter from the given STL container. More...
 
template<class TContainer >
static IEnumerator< T >::Ptr CreateStlAdapter (const TContainer &c)
 Creates an enumerator adapter from the given STL container. More...
 
template<class TContainer >
static IEnumerator< T >::Ptr CreateKeysAdapter (TContainer &c)
 Creates an enumerator adapter from the given STL map enumerating the keys. More...
 
template<class TContainer >
static IEnumerator< T >::Ptr CreateKeysAdapter (const TContainer &c)
 Creates an enumerator adapter from the given const STL map enumerating the keys. More...
 
template<class TContainer >
static IEnumerator< T >::Ptr CreateMappedAdapter (TContainer &c)
 Creates an enumerator adapter from the given STL map enumerating the mapped items. More...
 
template<class TContainer >
static IEnumerator< T >::Ptr CreateMappedAdapter (const TContainer &c)
 Creates an enumerator adapter from the given const STL map enumerating the mapped items. More...
 
template<class Predicate >
static IEnumerator< T >::Ptr CreateFilter (typename IEnumerator< T >::Ptr source, Predicate predicate)
 Creates a filtering adapter enumerating only the nodes matching a given predicate. More...
 
template<class SourceEnumerator , class TransformOperation >
static IEnumerator< T >::Ptr CreateTransform (std::shared_ptr< SourceEnumerator > source, TransformOperation transformOp)
 
- Protected Attributes inherited from Arp::Base::Core::Enumerator< T >
TCurrent current {}
 The current field of this enumerator.
 

Member Function Documentation

◆ MoveNext()

bool Arp::System::Commons::Configuration::PlaceholderExpression::Enumerator::MoveNext ( void  )
overridevirtual

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 files: