Container for a (relative) setting identifier with its value. More...

#include <DeviceSettingItem.hpp>

Inheritance diagram for Arp::Device::Interface::Services::DeviceSettingItem:

Public Member Functions
void	Serialize (RscWriter &writer) const override
	Serializes the datatype. All fields of the datatype have to be serialized in use of RscWriter. More...

void	Deserialize (RscReader &reader) override
	Deserializes the datatype. All fields of the datatype have to be deserialized in use of RscReader. More...

Public Member Functions inherited from Arp::System::Rsc::Services::IRscSerializable
virtual	~IRscSerializable ()=default
	default destructor More...

Static Public Member Functions
static size_t	GetFieldCount (void)

Static Public Member Functions inherited from Arp::System::Rsc::Services::IRscSerializable
static size_t	GetFieldCount (void)
	Returns the count of fields of the struct type More...

Public Attributes
RscString< 512 >	Setting
	Tokens which describe the (relative) path to the setting combined with the value. More...

RscVariant< 512 >	Value
	The value of the setting which is identified by the (relative) path which is described by the tokens. More...

Detailed Description

Container for a (relative) setting identifier with its value.

The structure is designed for efficient interpretation on the receiving side which is the Remoting server. The structure is used by Arp.Device.Interface.Services.IDeviceSettingsService.WriteValue A sequence of instances of this structure is intended to be passed to the method Arp.Device.Interface.Services.IDeviceSettingsService.WriteValues.

Member Function Documentation

◆ Deserialize()

void Arp::Device::Interface::Services::DeviceSettingItem::Deserialize ( RscReader & reader )

inlineoverridevirtual

Deserializes the datatype. All fields of the datatype have to be deserialized in use of RscReader.

Parameters

reader Reference to RscReader.

Implements Arp::System::Rsc::Services::IRscSerializable.

◆ Serialize()

void Arp::Device::Interface::Services::DeviceSettingItem::Serialize ( RscWriter & writer ) const

inlineoverridevirtual

Serializes the datatype. All fields of the datatype have to be serialized in use of RscWriter.

Parameters

writer Reference to RscWriter

Implements Arp::System::Rsc::Services::IRscSerializable.

Member Data Documentation

◆ Setting

RscString<512> Arp::Device::Interface::Services::DeviceSettingItem::Setting

Tokens which describe the (relative) path to the setting combined with the value.

If this instance of the structure

TokensAndValue

is part of a sequence (an array) then the preceeding instance's tokens already provide a context at which the tokens here start with their description.

◆ Value

RscVariant<512> Arp::Device::Interface::Services::DeviceSettingItem::Value

The value of the setting which is identified by the (relative) path which is described by the tokens.

The type of the value must match the value which is defined for the particular setting.

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

Arp/Device/Interface/Services/DeviceSettingItem.hpp

Public Member Functions

Static Public Member Functions