PLCnext API Documentation 26.0.1.58
TransferStatus.hpp
1
2//
3// Copyright Phoenix Contact GmbH & Co. KG
4//
6#pragma once
8#include "Arp/Base/Rsc/Commons/Rsc.hpp"
9#include "Arp/Base/JRsc/Commons/JRsc.hpp"
10#include "Arp/Base/Rsc/Commons/RscSerializable.hpp"
11#include "Arp/Base/Rsc/Commons/RscString.hxx"
12#include "Arp/Services/SoftwareUpdate/Services/StatusCode.hpp"
13
14// DO NOT MODIFY THIS FILE, THIS FILE IS AUTOGENERATED
15
16namespace Arp::Services::SoftwareUpdate::Services
17{
18
19using namespace Arp;
20using namespace Arp::Base::Rsc::Commons;
21using namespace Arp::Base::Rsc::Commons::Services;
22using namespace Arp::Base::JRsc::Commons;
23
27class ARP_EXPORT TransferStatus : public RscSerializable
28{
29public: // construction/destruction
31 TransferStatus(boolean inProgress, StatusCode result, const RscString<512>& errorMessage);
32
33public: // Properties
37 boolean InProgress = false;
38
42 StatusCode Result = static_cast<StatusCode>(0);
43
48
49public: // Rsc operations
50 void Serialize(RscWriter& writer)const;
51 void Deserialize(RscReader& reader);
52 void Serialize(JRscWriter& writer)const;
53 void Deserialize(JRscReader& reader);
54 static size_t GetFieldCount(void);
55};
56
57} // end of namespace Arp::Services::SoftwareUpdate::Services
Any custom struct type which is intended to be marshalled in a Rsc serialization context,...
Definition: RscSerializable.hpp:35
Reads marshaled data of RSC services.
Definition: RscReader.hpp:34
Writes marshalled data of RSC services.
Definition: RscWriter.hpp:34
Contains info about a transfer operation.
Definition: TransferStatus.hpp:28
TransferStatus(void)
Constructs an TransferStatus instance.
RscString< 512 > ErrorMessage
Additional info in case of an error.
Definition: TransferStatus.hpp:47
Namespace for the JSON RSC extension
@ InProgress
A blocking operation is currently executing.
Root namespace for the PLCnext API