PLCnext API Documentation 26.0.1.58
Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
Arp::Services::SoftwareUpdate::Services::TransferStatus Class Reference

Contains info about a transfer operation. More...

#include <TransferStatus.hpp>

Inheritance diagram for Arp::Services::SoftwareUpdate::Services::TransferStatus:
Inheritance graph

Public Member Functions

 TransferStatus (void)
 Constructs an TransferStatus instance.
 
 TransferStatus (boolean inProgress, StatusCode result, const RscString< 512 > &errorMessage)
 Constructs an TransferStatus 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

boolean InProgress = false
 Whether a transfer operation is still in progress.
 
StatusCode Result = static_cast<StatusCode>(0)
 Result of the last transfer operation.
 
RscString< 512 > ErrorMessage
 Additional info in case of an error.
 

Detailed Description

Contains info about a transfer operation.

Member Function Documentation

◆ Deserialize() [1/2]

void Arp::Services::SoftwareUpdate::Services::TransferStatus::Deserialize ( JRscReader &  reader)

Deserializes the datatype. All fields of the datatype have to be deserialized in use of JRscReader.

Parameters
readerReference to RscReader.

◆ Deserialize() [2/2]

void Arp::Services::SoftwareUpdate::Services::TransferStatus::Deserialize ( RscReader reader)

Deserializes the datatype. All fields of the datatype have to be deserialized in use of RscReader.

Parameters
readerReference to RscReader.

◆ GetFieldCount()

size_t Arp::Services::SoftwareUpdate::Services::TransferStatus::GetFieldCount ( void  )
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::TransferStatus::Serialize ( JRscWriter &  writer) const

Serializes the datatype. All fields of the datatype have to be serialized in use of JRscWriter.

Parameters
writerReference to RscWriter

◆ Serialize() [2/2]

void Arp::Services::SoftwareUpdate::Services::TransferStatus::Serialize ( RscWriter writer) const

Serializes the datatype. All fields of the datatype have to be serialized in use of RscWriter.

Parameters
writerReference to RscWriter

The documentation for this class was generated from the following files: