PLCnext API Documentation 23.6.0.37
Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
Arp::Io::ProfinetStack::Controller::Services::DiagnosticResult 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 <DiagnosticResult.hpp>

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

Public Member Functions

void Serialize (RscWriter &writer) const override
 Serializes the datatype. All fields of the datatype have to be serialized in use of RscWriter. More...
 
void Deserialize (RscReader &reader) override
 Deserializes the datatype. All fields of the datatype have to be deserialized in use of RscReader. More...
 
- Public Member Functions inherited from Arp::System::Rsc::Services::IRscSerializable
virtual ~IRscSerializable ()=default
 default destructor
 
virtual void Serialize (RscWriter &writer) const =0
 Serializes the datatype. All fields of the datatype have to be serialized in use of RscWriter. More...
 
virtual void Deserialize (RscReader &reader)=0
 Deserializes the datatype. All fields of the datatype have to be deserialized in use of RscReader. More...
 

Static Public Member Functions

static constexpr size_t GetFieldCount (void)
 
- Static Public Member Functions inherited from Arp::System::Rsc::Services::IRscSerializable
static size_t GetFieldCount (void)
 Returns the count of fields of the struct type More...
 

Public Attributes

ArDataAccessError ErrorCode = static_cast<ArDataAccessError>(0)
 An error code which describes the reason why a setting could not be read with The error codes can be interpreted with the help of the enumeration Arp.Io.ProfinetStack.Controller.Services.ArDataAccessError.
 
DiagnosticInfo PnDiagnosisInfo
 The value for the requested setting which can be

RscType::Void

and otherwise is of the simple type the setting has. More...

 

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.

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

Member Function Documentation

◆ Deserialize()

void Arp::Io::ProfinetStack::Controller::Services::DiagnosticResult::Deserialize ( RscReader reader)
inlineoverridevirtual

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

Parameters
readerReference to RscReader.

Implements Arp::System::Rsc::Services::IRscSerializable.

◆ Serialize()

void Arp::Io::ProfinetStack::Controller::Services::DiagnosticResult::Serialize ( RscWriter writer) const
inlineoverridevirtual

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

Parameters
writerReference to RscWriter

Implements Arp::System::Rsc::Services::IRscSerializable.

Member Data Documentation

◆ PnDiagnosisInfo

DiagnosticInfo Arp::Io::ProfinetStack::Controller::Services::DiagnosticResult::PnDiagnosisInfo

The value for the requested setting which can be

RscType::Void

and otherwise is of the simple type the setting has.

Please note that this property is

RscType::Void

whenever the member Arp.Io.ProfinetStack.Controller.Services.DiagnosticResult.ErrorCode indicates an error which means it is not Arp.Io.ProfinetStack.Controller.Services.ArDataAccessError.None.


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