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::DiagnosticInfo 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 <DiagnosticInfo.hpp>

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

Public Member Functions

 DiagnosticInfo (void)
 Constructs an DiagnosticInfo instance.
 
 DiagnosticInfo (uint16 arUserId, uint16 diagCode)
 Constructs an DiagnosticInfo 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

uint16 ArUserId = 0
 User specific identifier of this AR
 
uint16 DiagCode = 0
 Special status of this AR, bitwise coded. 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.

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

Member Function Documentation

◆ Deserialize() [1/2]

void Arp::Io::ProfinetStack::Controller::Services::DiagnosticInfo::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::DiagnosticInfo::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::DiagnosticInfo::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::DiagnosticInfo::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::DiagnosticInfo::Serialize ( RscWriter writer) const

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

Parameters
writerReference to RscWriter

Member Data Documentation

◆ DiagCode

uint16 Arp::Io::ProfinetStack::Controller::Services::DiagnosticInfo::DiagCode = 0

Special status of this AR, bitwise coded.

  • Bit 0: set if not connected
  • Bit 1: set if data invalid
  • Bit 2: set if diagnosis is available
  • Bit 3: set if module difference is available in case of configuration difference
  • Bit 4: set if AR is deactivated
  • Bit 5: set if neighborhood information is not available
  • Bit 6: neighborhood information not unique
  • Bit 7 - Identify.cnf on alias received, but name of the device is already configured in another AR
  • Bit 8: Maintenance Required Information is available
  • Bit 9: Maintenance Demanded Information is available
  • Bit 10: Channel or Manufacturer Specific Diagnosis Information are available
  • Bit 11..15: reserved (shall be 0)

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