Container for a (relative) setting identifier with its value. More...
#include <DeviceSettingItem.hpp>
Public Member Functions | |
| DeviceSettingItem (void) | |
| Constructs an DeviceSettingItem instance. | |
| DeviceSettingItem (const RscString< 512 > &setting, const RscVariant< 512 > &value) | |
| Constructs an DeviceSettingItem instance. | |
| void | Serialize (RscWriter &writer) const |
| Serializes the datatype. All fields of the datatype have to be serialized in use of RscWriter. More... | |
| void | Deserialize (RscReader &reader) |
| Deserializes the datatype. All fields of the datatype have to be deserialized in use of RscReader. More... | |
| void | Serialize (JRscWriter &writer) const |
| Serializes the datatype. All fields of the datatype have to be serialized in use of JRscWriter. More... | |
| void | Deserialize (JRscReader &reader) |
| Deserializes the datatype. All fields of the datatype have to be deserialized in use of JRscReader. More... | |
 Public Member Functions inherited from Arp::Base::Rsc::Commons::RscSerializable | |
| RscSerializable (void)=default | |
| The default constructor. | |
Static Public Member Functions | |
| static size_t | GetFieldCount (void) |
| Returns the count of fields 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() [1/2]
| void Arp::Device::Interface::Services::DeviceSettingItem::Deserialize | ( | JRscReader & | reader | ) |
Deserializes the datatype. All fields of the datatype have to be deserialized in use of JRscReader.
- Parameters
-
reader Reference to RscReader.
◆ Deserialize() [2/2]
| void Arp::Device::Interface::Services::DeviceSettingItem::Deserialize | ( | RscReader & | reader | ) |
Deserializes the datatype. All fields of the datatype have to be deserialized in use of RscReader.
- Parameters
-
reader Reference to RscReader.
◆ GetFieldCount()
|
static |
Returns the count of fields
- Returns
- Count of fields.
The field count is used for serialization via Rsc
◆ Serialize() [1/2]
| void Arp::Device::Interface::Services::DeviceSettingItem::Serialize | ( | JRscWriter & | writer | ) | const |
Serializes the datatype. All fields of the datatype have to be serialized in use of JRscWriter.
- Parameters
-
writer Reference to RscWriter
◆ Serialize() [2/2]
| void Arp::Device::Interface::Services::DeviceSettingItem::Serialize | ( | RscWriter & | writer | ) | const |
Serializes the datatype. All fields of the datatype have to be serialized in use of RscWriter.
- Parameters
-
writer Reference to RscWriter
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
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 class was generated from the following files:
- Arp/Device/Interface/Services/DeviceSettingItem.hpp
- Arp/Device/Interface/Services/DeviceSettingItem.cpp
