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

Result of the PcpIdentify service More...

#include <IdentifyResult.hpp>

Inheritance diagram for Arp::Io::Interbus::Services::IdentifyResult:
Inheritance graph

Public Member Functions

 IdentifyResult (void)
 Constructs an IdentifyResult instance.
 
 IdentifyResult (uint16 result, uint16 additionalCode, const RscString< 512 > &manufacturerName, const RscString< 512 > &deviceName, const RscString< 512 > &revision)
 Constructs an IdentifyResult 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...
 
- 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 Result = 0
 Result describes the error cause. (0 = No error) To get the meaning of Result, please refer to the PCP manual. There you will find a section of error codes.
 
uint16 AdditionalCode = 0
 AdditionalCode gives additional information about the error cause described by Result. To get the meaning of AdditionalCode, please refer to the PCP manual. There you will find a section of error codes.
 
RscString< 512 > ManufacturerName
 Manufacturer name
 
RscString< 512 > DeviceName
 Device name
 
RscString< 512 > Revision
 Revision
 

Detailed Description

Result of the PcpIdentify service

Member Function Documentation

◆ Deserialize()

void Arp::Io::Interbus::Services::IdentifyResult::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::Interbus::Services::IdentifyResult::GetFieldCount ( void  )
static

Returns the count of fields

Returns
Count of fields.

The field count is used for serialization via Rsc

◆ Serialize()

void Arp::Io::Interbus::Services::IdentifyResult::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: