PLCnext API Documentation 25.0.2.69
Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
Arp::Services::AppManager::Services::AppInfo Class Reference

This structure is used for PLCnext application information indication. More...

#include <AppInfo.hpp>

Inheritance diagram for Arp::Services::AppManager::Services::AppInfo:
Inheritance graph

Public Member Functions

 AppInfo (void)
 Constructs an AppInfo instance.
 
 AppInfo (const RscString< 256 > &appIdentifier, const RscString< 256 > &appName, const RscString< 256 > &version, const RscString< 256 > &target, const RscString< 256 > &minFirmwareVersion, const RscString< 256 > &manufacturer, AppLicenseType licenseType, const RscString< 512 > &linkToAppPage, const std::vector< AdditionalAppInfo > &additionalInfo)
 Constructs an AppInfo 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< 256 > AppIdentifier
 The unique identifier for the application.
 
RscString< 256 > AppName
 The name of the application.
 
RscString< 256 > Version
 The version of the application.
 
RscString< 256 > Target
 The target platform for the application.
 
RscString< 256 > MinFirmwareVersion
 The minimum firmware version required for the application.
 
RscString< 256 > Manufacturer
 The manufacturer of the application.
 
AppLicenseType LicenseType = static_cast<AppLicenseType>(0)
 The type of license the application is distributed under.
 
RscString< 512 > LinkToAppPage
 URL that points to a web page providing the app (optional)
 
std::vector< AdditionalAppInfoAdditionalInfo
 Additional infomation (optional).
 

Detailed Description

This structure is used for PLCnext application information indication.

Member Function Documentation

◆ Deserialize() [1/2]

void Arp::Services::AppManager::Services::AppInfo::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::AppManager::Services::AppInfo::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::AppManager::Services::AppInfo::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::AppManager::Services::AppInfo::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::AppManager::Services::AppInfo::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: