Container for a combination of an error code and a value which is a result for a read operation to a single setting. More...
#include <DeviceSettingResult.hpp>
Public Member Functions | |
| DeviceSettingResult (void) | |
| Constructs an DeviceSettingResult instance. | |
| DeviceSettingResult (AccessErrorCode errorCode, const RscVariant< 512 > &value) | |
| Constructs an DeviceSettingResult 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 | |
| AccessErrorCode | ErrorCode = static_cast<AccessErrorCode>(0) |
| An error code which describes the reason why a setting could not be read with The error codes can be interpreted with the help of the enumeration Arp.Device.Interface.Services.AccessErrorCode. | |
| RscVariant< 512 > | Value |
| The value for the requested setting which can be RscType::Void
and otherwise is of the simple type the setting has. More... | |
Detailed Description
Container for a combination of an error code and a value which is a result for a read operation to a single setting.
The structure is used as result by Arp.Device.Interface.Services.IDeviceSettingsService.ReadValue A sequence of instances of this structure is used as result by Arp.Device.Interface.Services.IDeviceSettingsService.ReadValues.
Member Function Documentation
◆ Deserialize() [1/2]
| void Arp::Device::Interface::Services::DeviceSettingResult::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::DeviceSettingResult::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::DeviceSettingResult::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::DeviceSettingResult::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
◆ Value
| RscVariant<512> Arp::Device::Interface::Services::DeviceSettingResult::Value |
The value for the requested setting which can be
and otherwise is of the simple type the setting has.
Please note that this property is
whenever the member Arp.Device.Interface.Services.DeviceSettingResult.ErrorCode indicates an error which means it is not Arp.Device.Interface.Services.AccessErrorCode.None.
The documentation for this class was generated from the following files:
- Arp/Device/Interface/Services/DeviceSettingResult.hpp
- Arp/Device/Interface/Services/DeviceSettingResult.cpp
