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

Contains error information of an executed acyclic Axioline service. More...

#include <PdiResult.hpp>

Inheritance diagram for Arp::Io::Axioline::Services::PdiResult:
Inheritance graph

Public Member Functions

 PdiResult (void)
 Constructs an PdiResult instance.
 
 PdiResult (boolean serviceDone, uint16 errorCode, uint16 addInfo)
 Constructs an PdiResult 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

boolean ServiceDone = false
 Flag is set when service is done. Is only needed in non-blocking methods.
 
uint16 ErrorCode = 0
 Error code: If 0 the service was executed successfully, other values show an error. See module and Axioline documentation.
 
uint16 AddInfo = 0
 Additional information: If the service returns with error this field contains additional information.
 

Detailed Description

Contains error information of an executed acyclic Axioline service.

Member Function Documentation

◆ Deserialize()

void Arp::Io::Axioline::Services::PdiResult::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::Axioline::Services::PdiResult::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::Axioline::Services::PdiResult::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: