PLCnext API Documentation 25.0.2.69
Public Member Functions | List of all members
Arp::Base::Rsc::Commons::Services::SerializationContext Class Reference

This class serves as base class for all serialization contexts supported by RSC. More...

#include <SerializationContext.hpp>

Inheritance diagram for Arp::Base::Rsc::Commons::Services::SerializationContext:
Inheritance graph

Public Member Functions

 SerializationContext (SerializationKind kind)
 Constructs a serialization context with the supplied serialization kind. More...
 
 SerializationContext (const SerializationContext &arg)
 The default copy constructor. More...
 
 SerializationContext (SerializationContext &&arg) noexcept
 The default move constructor. More...
 
SerializationContextoperator= (const SerializationContext &arg)
 The default copy-assignment operator. More...
 
SerializationContextoperator= (SerializationContext &&arg) noexcept
 The default move-assignment operator. More...
 
virtual ~SerializationContext (void)
 The default destructor.
 
SerializationKind GetSerializationKind (void) const
 Gets the serialization kind of this context. More...
 

Detailed Description

This class serves as base class for all serialization contexts supported by RSC.

The RSC supports different kinds of remote communication, which require different kinds of serialization, e.g. the ARP remoting technology implements a very compact binary protocol, while the WBM technology uses a textual protocol based on JSON.

This class is not intended for direct use, but required by RscGenerator to implement services.

Constructor & Destructor Documentation

◆ SerializationContext() [1/3]

Arp::Base::Rsc::Commons::Services::SerializationContext::SerializationContext ( SerializationKind  kind)
explicit

Constructs a serialization context with the supplied serialization kind.

Parameters
kindThe serialization kind of this context.

◆ SerializationContext() [2/3]

Arp::Base::Rsc::Commons::Services::SerializationContext::SerializationContext ( const SerializationContext arg)
default

The default copy constructor.

Parameters
argThe argument to copy.

◆ SerializationContext() [3/3]

Arp::Base::Rsc::Commons::Services::SerializationContext::SerializationContext ( SerializationContext &&  arg)
defaultnoexcept

The default move constructor.

Parameters
argThe argument to move.

Member Function Documentation

◆ GetSerializationKind()

SerializationKind Arp::Base::Rsc::Commons::Services::SerializationContext::GetSerializationKind ( void  ) const

Gets the serialization kind of this context.

Returns
The serialization kind of this context.

◆ operator=() [1/2]

SerializationContext & Arp::Base::Rsc::Commons::Services::SerializationContext::operator= ( const SerializationContext arg)
default

The default copy-assignment operator.

Parameters
argThe argument to copy.
Returns
This instance.

◆ operator=() [2/2]

SerializationContext & Arp::Base::Rsc::Commons::Services::SerializationContext::operator= ( SerializationContext &&  arg)
defaultnoexcept

The default move-assignment operator.

Parameters
argThe argument to move.
Returns
This instance.

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