PLCnext API Documentation 25.0.2.69
Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
Arp::Io::ProfinetStack::Controller::Services::ArInfo Class Reference

Container for a combination of an error code and a value which is a result for a read operation to a single setting. More...

#include <ArInfo.hpp>

Inheritance diagram for Arp::Io::ProfinetStack::Controller::Services::ArInfo:
Inheritance graph

Public Member Functions

 ArInfo (void)
 Constructs an ArInfo instance.
 
 ArInfo (const RscString< 256 > &dnsName, uint16 arUserId)
 Constructs an ArInfo 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 > DnsName
 The configured dns station name of the profinet device. According to profinet spec. the maximum string size is 240.
 
uint16 ArUserId = 0
 The configured ArUserId of the profinet device.
 

Detailed Description

Container for a combination of an error code and a value which is a result for a read operation to a single setting.

A sequence of instances of this structure is used as result by Arp.Io.ProfinetStack.Controller.Services.IArDataService.GetAllArInfo.

Member Function Documentation

◆ Deserialize() [1/2]

void Arp::Io::ProfinetStack::Controller::Services::ArInfo::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::Io::ProfinetStack::Controller::Services::ArInfo::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::Io::ProfinetStack::Controller::Services::ArInfo::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::Io::ProfinetStack::Controller::Services::ArInfo::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::Io::ProfinetStack::Controller::Services::ArInfo::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: