IRscReadEnumerator.hxx

//
//  Copyright PHOENIX CONTACT Electronics GmbH
//
#pragma once
#include "Arp/System/Core/Arp.h"

namespace Arp { namespace System { namespace Rsc { namespace Services
{

// forwards
class RscArrayReader;

template<class T>
class IRscReadEnumerator
{
public: // typedefs
    typedef std::shared_ptr<IRscReadEnumerator> Ptr;

protected: // construction/destruction
    IRscReadEnumerator(void) = default;

    virtual ~IRscReadEnumerator(void) = default;

public: // abstract operations
    virtual size_t      BeginRead(void) = 0;

    virtual bool        ReadNext(T& current) = 0;

    virtual bool        ReadNext(RscArrayReader& current) = 0;

    virtual void        EndRead(void) = 0;

protected: // deleted methods
    IRscReadEnumerator(const IRscReadEnumerator& arg) = default;
    IRscReadEnumerator& operator=(const IRscReadEnumerator& arg) = default;

public:
    static constexpr size_t UndefinedArrayLength = std::numeric_limits<size_t>::max();
};

}}}} // end of namespace Arp::System::Rsc::Services