PLCnext API Documentation 26.0.1.58
SoftwareUpdateStatus.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/InstallationState.hpp"
13#include "Arp/Services/SoftwareUpdate/Services/PrepareForUpdateState.hpp"
14
15// DO NOT MODIFY THIS FILE, THIS FILE IS AUTOGENERATED
16
17namespace Arp::Services::SoftwareUpdate::Services
18{
19
20using namespace Arp;
21using namespace Arp::Base::Rsc::Commons;
22using namespace Arp::Base::Rsc::Commons::Services;
23using namespace Arp::Base::JRsc::Commons;
24
30class ARP_EXPORT SoftwareUpdateStatus : public RscSerializable
31{
32public: // construction/destruction
34 SoftwareUpdateStatus(const RscString<512>& updateStatus, PrepareForUpdateState stateOfPrepareForUpdate, int32 percentCompleteOfInstallation, InstallationState stateOfInstallation, boolean waitingForConfirm);
35
36public: // Properties
41
45 PrepareForUpdateState StateOfPrepareForUpdate = static_cast<PrepareForUpdateState>(0);
46
51 int32 PercentCompleteOfInstallation = 0;
52
56 InstallationState StateOfInstallation = static_cast<InstallationState>(0);
57
61 boolean WaitingForConfirm = false;
62
63public: // Rsc operations
64 void Serialize(RscWriter& writer)const;
65 void Deserialize(RscReader& reader);
66 void Serialize(JRscWriter& writer)const;
67 void Deserialize(JRscReader& reader);
68 static size_t GetFieldCount(void);
69};
70
71} // 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
The UpdateStatus may be used together with the PrepareForUpdateStateMachineType, the InstallationStat...
Definition: SoftwareUpdateStatus.hpp:31
RscString< 512 > UpdateStatus
Status and error information for the user in English.
Definition: SoftwareUpdateStatus.hpp:40
SoftwareUpdateStatus(void)
Constructs an SoftwareUpdateStatus instance.
std::int32_t int32
The Arp integer type of 4 byte size.
Definition: PrimitiveTypes.hpp:35
Namespace for the JSON RSC extension
Root namespace for the PLCnext API