Arp::System::Rsc::Services::RscReadEnumerator< T > Class Template Reference

Implementation of IRscReadEnumerator used on client side. More...

#include <RscReadEnumerator.hxx>

Inheritance diagram for Arp::System::Rsc::Services::RscReadEnumerator< T >:

Public Member Functions
	RscReadEnumerator (RscReader &rscReader, bool isArrayEnumerator)
	Constructs an RscEnumeratorBase instance. More...
	RscReadEnumerator (const RscReadEnumerator &arg)=default
	Copy constructor. More...
	~RscReadEnumerator (void)
	Destructs this instance and frees all resources. More...
size_t	BeginRead (void) override
	Begins the operation to read the enumerator. More...
bool	ReadNext (T &current) override
	Reads the next enumerator element. More...
bool	ReadNext (RscArrayReader &current) override
	Reads the next array enumerator element. Use this method only, if element contains object with an array. More...
void	EndRead (void) override
	Ends the operation to read the enumerator. All enumerator elements had to be already been read. More...

Static Public Attributes
static constexpr size_t	UndefinedArrayLength = std::numeric_limits<size_t>::max()
Static Public Attributes inherited from Arp::System::Rsc::Services::IRscReadEnumerator< T >
static constexpr size_t	UndefinedArrayLength = std::numeric_limits<size_t>::max()

Additional Inherited Members
Public Types inherited from Arp::System::Rsc::Services::IRscReadEnumerator< T >
typedef std::shared_ptr< IRscReadEnumerator >	Ptr
Protected Member Functions inherited from Arp::System::Rsc::Services::IRscReadEnumerator< T >
	IRscReadEnumerator (void)=default
	Constructs an IRscArrayWriteEnumerator instance. More...
virtual	~IRscReadEnumerator (void)=default
	Destructs this instance and frees all resources. More...
	IRscReadEnumerator (const IRscReadEnumerator &arg)=default
IRscReadEnumerator &	operator= (const IRscReadEnumerator &arg)=default

Detailed Description

template<class T>
class Arp::System::Rsc::Services::RscReadEnumerator< T >

Implementation of IRscReadEnumerator used on client side.

Constructor & Destructor Documentation

RscReadEnumerator() [1/2]

template<class T >

Arp::System::Rsc::Services::RscReadEnumerator< T >::RscReadEnumerator ( RscReader &  rscReader, bool  isArrayEnumerator  )

inline

Constructs an RscEnumeratorBase instance.

RscReadEnumerator() [2/2]

template<class T >

Arp::System::Rsc::Services::RscReadEnumerator< T >::RscReadEnumerator ( const RscReadEnumerator< T > &  arg )

default

Copy constructor.

~RscReadEnumerator()

template<class T >

Arp::System::Rsc::Services::RscReadEnumerator< T >::~RscReadEnumerator ( void  )

inline

Destructs this instance and frees all resources.

Member Function Documentation

BeginRead()

template<class T >

size_t Arp::System::Rsc::Services::RscReadEnumerator< T >::BeginRead ( void  )

inlineoverridevirtual

Begins the operation to read the enumerator.

Returns

Number of elements for array enumerators. UndefinedArrayLength for regular enumerators

Implements Arp::System::Rsc::Services::IRscReadEnumerator< T >.

EndRead()

template<class T >

void Arp::System::Rsc::Services::RscReadEnumerator< T >::EndRead ( void  )

inlineoverridevirtual

Ends the operation to read the enumerator. All enumerator elements had to be already been read.

Implements Arp::System::Rsc::Services::IRscReadEnumerator< T >.

ReadNext() [1/2]

template<class T >

bool Arp::System::Rsc::Services::RscReadEnumerator< T >::ReadNext ( T &  current )

inlineoverridevirtual

Reads the next enumerator element.

Parameters

current

Place to store next element

Returns

true if valid element was read

Implements Arp::System::Rsc::Services::IRscReadEnumerator< T >.

ReadNext() [2/2]

template<class T >

bool Arp::System::Rsc::Services::RscReadEnumerator< T >::ReadNext ( RscArrayReader &  current )

inlineoverridevirtual

Reads the next array enumerator element. Use this method only, if element contains object with an array.

Parameters

current

Reference to RscArrayReader. The given RscArrayReader will be configured by this method.

Returns

true if valid element was read

Implements Arp::System::Rsc::Services::IRscReadEnumerator< T >.

---

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

• Arp/System/Rsc/Services/RscReadEnumerator.hxx