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

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

#include <RscWriteEnumerator.hxx>

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

Public Member Functions
	RscWriteEnumerator (RscWriter &rscWriter, bool isArrayEnumerator)
	Constructs an RscEnumeratorBase instance. More...
	RscWriteEnumerator (const RscWriteEnumerator &arg)=default
	Copy constructor. More...
	~RscWriteEnumerator (void)
	Destructs this instance and frees all resources. More...
void	BeginWrite (size_t arrayLengthArg=(size_t) -1) override
	Begins the operation to write the enumerator. More...
void	WriteNext (const T &current) override
	Writes the next enumerator element. More...
RscArrayWriter	WriteNext (size_t arraySize, RscType arrayElementType) override
	Writes the next enumerator element if the element contains an array object. More...
void	EndWrite (void) override
	Ends the enumerator. With an array enumerator all enumerator elements had to be written More...

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

Detailed Description

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

Implementation of IRscWriteEnumerator used on client side.

Constructor & Destructor Documentation

RscWriteEnumerator() [1/2]

template<class T >

Arp::System::Rsc::Services::RscWriteEnumerator< T >::RscWriteEnumerator ( RscWriter &  rscWriter, bool  isArrayEnumerator  )

inline

Constructs an RscEnumeratorBase instance.

RscWriteEnumerator() [2/2]

template<class T >

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

default

Copy constructor.

~RscWriteEnumerator()

template<class T >

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

inline

Destructs this instance and frees all resources.

Member Function Documentation

BeginWrite()

template<class T >

void Arp::System::Rsc::Services::RscWriteEnumerator< T >::BeginWrite ( size_t  size = (size_t) -1 )

inlineoverridevirtual

Begins the operation to write the enumerator.

Parameters

size	Number of elements in case of array enumerator. UndefinedArrayLength for regular enumerators

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

EndWrite()

template<class T >

void Arp::System::Rsc::Services::RscWriteEnumerator< T >::EndWrite ( void  )

inlineoverridevirtual

Ends the enumerator. With an array enumerator all enumerator elements had to be written

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

WriteNext() [1/2]

template<class T >

void Arp::System::Rsc::Services::RscWriteEnumerator< T >::WriteNext ( const T &  current )

inlineoverridevirtual

Writes the next enumerator element.

Parameters

current

Reference to the next element

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

WriteNext() [2/2]

template<class T >

RscArrayWriter Arp::System::Rsc::Services::RscWriteEnumerator< T >::WriteNext ( size_t  arraySize, RscType  elementType  )

inlineoverridevirtual

Writes the next enumerator element if the element contains an array object.

Parameters

arraySize	Number of array elements
arrayElementType	RsyType of array elements

Returns

Configured RscArrayWriter to write array elements

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

---

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

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