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

Result of the PcpStatus service More...

#include <StatusResult.hpp>

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

Public Member Functions

 StatusResult (void)
 Constructs an StatusResult instance.
 
 StatusResult (uint16 result, uint16 additionalCode, uint8 physicalStatus, uint8 logicalStatus, const RscString< 512 > &localDetails)
 Constructs an StatusResult 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.
 
uint8 PhysicalStatus = 0
 Physical status of device
 
uint8 LogicalStatus = 0
 Logical status of device
 
RscString< 512 > LocalDetails
 Detailed information on device status
 

Detailed Description

Result of the PcpStatus service

Member Function Documentation

◆ Deserialize()

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