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

Result on PcpStatus service More...

#include <StatusResult.hpp>

Inheritance diagram for Arp::Io::Interbus::Services::StatusResult:
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 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

uint16 Result = 0
 Result describes the error cause. (0 = No error) To get the meaning of Result, please look in the PCP manual. You will find there a section with error codes. More...
 
uint16 AdditionalCode = 0
 AdditionalCode gives additional information about the error cause described by Result. To get the meaning of AdditionalCode, please look in the PCP manual. You will find there a section with error codes. More...
 
uint8 PhysicalStatus = 0
 Physical status of device More...
 
uint8 LogicalStatus = 0
 Logical status of device More...
 
RscString< 512 > LocalDetails
 Detailed information on device status More...
 

Detailed Description

Result on PcpStatus service

Member Function Documentation

◆ Deserialize()

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

◆ AdditionalCode

uint16 Arp::Io::Interbus::Services::StatusResult::AdditionalCode = 0

AdditionalCode gives additional information about the error cause described by Result. To get the meaning of AdditionalCode, please look in the PCP manual. You will find there a section with error codes.

◆ LocalDetails

RscString<512> Arp::Io::Interbus::Services::StatusResult::LocalDetails

Detailed information on device status

◆ LogicalStatus

uint8 Arp::Io::Interbus::Services::StatusResult::LogicalStatus = 0

Logical status of device

◆ PhysicalStatus

uint8 Arp::Io::Interbus::Services::StatusResult::PhysicalStatus = 0

Physical status of device

◆ Result

uint16 Arp::Io::Interbus::Services::StatusResult::Result = 0

Result describes the error cause. (0 = No error) To get the meaning of Result, please look in the PCP manual. You will find there a section with error codes.


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