PLCnext API Documentation 23.6.0.37
BackupResult.hpp
1
2//
3// Copyright PHOENIX CONTACT Electronics GmbH
4//
6#pragma once
8#include "Arp/Plc/Retain/Services/BackupError.hpp"
9#include "Arp/System/Rsc/Services/IRscSerializable.hpp"
10#include "Arp/System/Rsc/Services/RscReader.hpp"
11#include "Arp/System/Rsc/Services/RscString.hxx"
12#include "Arp/System/Rsc/Services/RscWriter.hpp"
13
14// DO NOT MODIFY THIS FILE, THIS FILE IS AUTOGENERATED
15
16namespace Arp { namespace Plc { namespace Retain { namespace Services
17{
18
19using namespace Arp;
20using namespace Arp::System::Rsc::Services;
21
24{
25public:
28
30 BackupError Error = static_cast<BackupError>(0);
31
32 void Serialize(RscWriter& writer)const override
33 {
34 writer.Write(this->FileName);
35 writer.Write(this->Error);
36 }
37
38 void Deserialize(RscReader& reader)override
39 {
40 reader.Read(this->FileName);
41 reader.Read(this->Error);
42 }
43
44 static constexpr size_t GetFieldCount(void)
45 {
46 return 2;
47 }
48};
49
50}}}} // end of namespace Arp::Plc::Retain::Services
Contains the name and error code of the backup.
Definition: BackupResult.hpp:24
RscString< 256 > FileName
Name of the backup file.
Definition: BackupResult.hpp:27
void Deserialize(RscReader &reader) override
Deserializes the datatype. All fields of the datatype have to be deserialized in use of RscReader.
Definition: BackupResult.hpp:38
void Serialize(RscWriter &writer) const override
Serializes the datatype. All fields of the datatype have to be serialized in use of RscWriter.
Definition: BackupResult.hpp:32
BackupError Error
Backup error.
Definition: BackupResult.hpp:30
Marshalls structure or class data types. Serialize and Deserialize have to marshal fields in the same...
Definition: IRscSerializable.hpp:20
Reads data from Rsc
Definition: RscReader.hpp:27
T Read(void)
Reads an element of T from Rsc. With data tagging enabled RscType of T is validated.
Definition: RscReader.hpp:166
Writes data to Rsc.
Definition: RscWriter.hpp:32
void Write(const T &value)
Writes an element of T from Rsc. Datatag and format is determined deducted by type of T.
Definition: RscWriter.hpp:178
@ Retain
The node shall be retained.
BackupError
Possible error codes for retain rsc services.
Definition: BackupError.hpp:19
Namespace for classes and interfaces for the Remote Service Call implementation
Root namespace for the PLCnext API