PLCnext API Documentation 26.6.0.38
Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
Arp::Services::BackupAndRestore::Services::Backup Class Reference

Description of a backup. More...

#include <Backup.hpp>

Inheritance diagram for Arp::Services::BackupAndRestore::Services::Backup:
Inheritance graph

Public Member Functions

 Backup (void)
 Constructs an Backup instance.
 
 Backup (const RscString< 64 > &name, const RscString< 512 > &filename, const RscString< 512 > &manufacturer, const RscString< 512 > &manufacturerUri, const RscString< 512 > &productCode, const RscString< 512 > &model, const RscString< 512 > &targetFirmwareRevision, DateTime releaseDate, VerificationIssue issue)
 Constructs an Backup 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< 64 > Name
 The backup name assigned during creation.
 
RscString< 512 > Filename
 The name of the backup file. The backup file is stored in $ARP_PATH_DATA_DIR$/Services/BackupAndRestore/[Filename]
 
RscString< 512 > Manufacturer
 The manufacturer of the device.
 
RscString< 512 > ManufacturerUri
 The unique identifier for the manufacturer of the device.
 
RscString< 512 > ProductCode
 The product code of the device.
 
RscString< 512 > Model
 A human readable name of the product code.
 
RscString< 512 > TargetFirmwareRevision
 The target firmware version of the backup.
 
DateTime ReleaseDate
 Release date of the backup, which should be the time of creation.
 
VerificationIssue Issue = static_cast<VerificationIssue>(0)
 Bit field for verification errors (and warnings).
 

Detailed Description

Description of a backup.

Member Function Documentation

◆ Deserialize() [1/2]

void Arp::Services::BackupAndRestore::Services::Backup::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::BackupAndRestore::Services::Backup::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::BackupAndRestore::Services::Backup::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::BackupAndRestore::Services::Backup::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::BackupAndRestore::Services::Backup::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: