The UpdateStatus may be used together with the PrepareForUpdateStateMachineType, the InstallationStateMachineType, or may be used during the transfer of the software package. The semantics are based on Version 1.03 of OPC UA Part 100: Devices (OPC 10000-100: OPC Unified Architecture). More...
#include <SoftwareUpdateStatus.hpp>
Public Member Functions | |
| SoftwareUpdateStatus (void) | |
| Constructs an SoftwareUpdateStatus instance. | |
| SoftwareUpdateStatus (const RscString< 512 > &updateStatus, PrepareForUpdateState stateOfPrepareForUpdate, int32 percentCompleteOfInstallation, InstallationState stateOfInstallation, boolean waitingForConfirm) | |
| Constructs an SoftwareUpdateStatus 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 > | UpdateStatus |
| Status and error information for the user in English. | |
| PrepareForUpdateState | StateOfPrepareForUpdate = static_cast<PrepareForUpdateState>(0) |
| The state for the prepare for update state machine. | |
| int32 | PercentCompleteOfInstallation = 0 |
| The percentage progress of installation (0..100) for display to the user. The progress is calculated by the updater. | |
| InstallationState | StateOfInstallation = static_cast<InstallationState>(0) |
| The state of the installation state machine. | |
| boolean | WaitingForConfirm = false |
| True if the device is waiting for confirmation. | |
Detailed Description
The UpdateStatus may be used together with the PrepareForUpdateStateMachineType, the InstallationStateMachineType, or may be used during the transfer of the software package. The semantics are based on Version 1.03 of OPC UA Part 100: Devices (OPC 10000-100: OPC Unified Architecture).
Member Function Documentation
◆ Deserialize() [1/2]
| void Arp::Services::SoftwareUpdate::Services::SoftwareUpdateStatus::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::Services::SoftwareUpdate::Services::SoftwareUpdateStatus::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::Services::SoftwareUpdate::Services::SoftwareUpdateStatus::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::Services::SoftwareUpdate::Services::SoftwareUpdateStatus::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
The documentation for this class was generated from the following files:
- Arp/Services/SoftwareUpdate/Services/SoftwareUpdateStatus.hpp
- Arp/Services/SoftwareUpdate/Services/SoftwareUpdateStatus.cpp
