PLCnext API Documentation  22.9.0.33
Public Types | Public Member Functions | List of all members
Arp::System::Rsc::Services::RscStructWriter< MaxStringSize > Class Template Reference

Helper class to write a struct from an RscVariant. This class uses the struct information stored in RscVariant. More...

#include <RscStructWriter.hxx>

Public Types

using WriteElementFunction = RscVariant<>::WriteElementFunction
 

Public Member Functions

 RscStructWriter (const RscVariant< MaxStringSize > &structVariant)
 Constructs an RscStructWriter instance. More...
 
 RscStructWriter (const RscStructWriter &arg)=default
 Copy constructor. More...
 
RscStructWriteroperator= (const RscStructWriter &arg)=default
 Assignment operator. More...
 
 ~RscStructWriter (void)=default
 Destructs this instance and frees all resources. More...
 
template<class T >
void WriteNextField (const T &currentField)
 Writes the next field with primitive Type. More...
 
void WriteNextField (const RscVariant< MaxStringSize > &currentField)
 Writes the next field that is contained in currentField. This method supports RscVariants with array and struct information. More...
 
void WriteNextField (const RscString< MaxStringSize > &currentField)
 Writes the next string field. More...
 

Detailed Description

template<int MaxStringSize>
class Arp::System::Rsc::Services::RscStructWriter< MaxStringSize >

Helper class to write a struct from an RscVariant. This class uses the struct information stored in RscVariant.

Constructor & Destructor Documentation

◆ RscStructWriter() [1/2]

template<int MaxStringSize>
Arp::System::Rsc::Services::RscStructWriter< MaxStringSize >::RscStructWriter ( const RscVariant< MaxStringSize > &  structVariant)
inline

Constructs an RscStructWriter instance.

◆ RscStructWriter() [2/2]

template<int MaxStringSize>
Arp::System::Rsc::Services::RscStructWriter< MaxStringSize >::RscStructWriter ( const RscStructWriter< MaxStringSize > &  arg)
default

Copy constructor.

◆ ~RscStructWriter()

template<int MaxStringSize>
Arp::System::Rsc::Services::RscStructWriter< MaxStringSize >::~RscStructWriter ( void  )
default

Destructs this instance and frees all resources.

Member Function Documentation

◆ operator=()

template<int MaxStringSize>
RscStructWriter& Arp::System::Rsc::Services::RscStructWriter< MaxStringSize >::operator= ( const RscStructWriter< MaxStringSize > &  arg)
default

Assignment operator.

◆ WriteNextField() [1/3]

template<int MaxStringSize>
void Arp::System::Rsc::Services::RscStructWriter< MaxStringSize >::WriteNextField ( const RscString< MaxStringSize > &  currentField)
inline

Writes the next string field.

Parameters
currentFieldReference to RscString

◆ WriteNextField() [2/3]

template<int MaxStringSize>
void Arp::System::Rsc::Services::RscStructWriter< MaxStringSize >::WriteNextField ( const RscVariant< MaxStringSize > &  currentField)
inline

Writes the next field that is contained in currentField. This method supports RscVariants with array and struct information.

Parameters
currentFieldReference to RscVariant with data

◆ WriteNextField() [3/3]

template<int MaxStringSize>
template<class T >
void Arp::System::Rsc::Services::RscStructWriter< MaxStringSize >::WriteNextField ( const T &  currentField)
inline

Writes the next field with primitive Type.

Parameters
currentFieldReference to value
Template Parameters
TType of value

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