PLCnext API Documentation 23.6.0.37
InitiateResult.hpp
1
2//
3// Copyright PHOENIX CONTACT Electronics GmbH
4//
6#pragma once
8#include "Arp/Io/Interbus/Services/NegativeInitiateResult.hpp"
9#include "Arp/Io/Interbus/Services/PositiveInitiateResult.hpp"
10#include "Arp/System/Rsc/Services/IRscSerializable.hpp"
11#include "Arp/System/Rsc/Services/RscReader.hpp"
12#include "Arp/System/Rsc/Services/RscWriter.hpp"
13
14// DO NOT MODIFY THIS FILE, THIS FILE IS AUTOGENERATED
15
16namespace Arp { namespace Io { namespace Interbus { namespace Services
17{
18
19using namespace Arp;
20using namespace Arp::System::Rsc::Services;
21
26{
27public:
34
41
46
51
52 void Serialize(RscWriter& writer)const override
53 {
54 writer.Write(this->Result);
55 writer.Write(this->AdditionalCode);
56 writer.Write(this->PositiveConfirmation);
57 writer.Write(this->NegativeConfirmation);
58 }
59
60 void Deserialize(RscReader& reader)override
61 {
62 reader.Read(this->Result);
63 reader.Read(this->AdditionalCode);
64 reader.Read(this->PositiveConfirmation);
65 reader.Read(this->NegativeConfirmation);
66 }
67
68 static constexpr size_t GetFieldCount(void)
69 {
70 return 4;
71 }
72};
73
74}}}} // end of namespace Arp::Io::Interbus::Services
Contains result the PcpInitiate service
Definition: InitiateResult.hpp:26
void Serialize(RscWriter &writer) const override
Serializes the datatype. All fields of the datatype have to be serialized in use of RscWriter.
Definition: InitiateResult.hpp:52
NegativeInitiateResult NegativeConfirmation
If Result is not 0 (Error), NegativeConfirmation contains the result. Arp.Io.Interbus....
Definition: InitiateResult.hpp:50
void Deserialize(RscReader &reader) override
Deserializes the datatype. All fields of the datatype have to be deserialized in use of RscReader.
Definition: InitiateResult.hpp:60
uint16 Result
Result describes the error cause. (0 = No error) To get the meaning of Result, please refer to the PC...
Definition: InitiateResult.hpp:33
PositiveInitiateResult PositiveConfirmation
If Result = 0 (No error), PositiveConfirmation contains the result. Arp.Io.Interbus....
Definition: InitiateResult.hpp:45
uint16 AdditionalCode
AdditionalCode gives additional information about the error cause described by Result....
Definition: InitiateResult.hpp:40
Result of an unsuccessful PcpInitiate service
Definition: NegativeInitiateResult.hpp:25
Result of a successful PcpInitiate service
Definition: PositiveInitiateResult.hpp:24
Marshalls structure or class data types. Serialize and Deserialize have to marshal fields in the same...
Definition: IRscSerializable.hpp:20
Reads data from Rsc
Definition: RscReader.hpp:27
T Read(void)
Reads an element of T from Rsc. With data tagging enabled RscType of T is validated.
Definition: RscReader.hpp:166
Writes data to Rsc.
Definition: RscWriter.hpp:32
void Write(const T &value)
Writes an element of T from Rsc. Datatag and format is determined deducted by type of T.
Definition: RscWriter.hpp:178
std::uint16_t uint16
The Arp unsigned integer type of 2 byte size.
Definition: PrimitiveTypes.hpp:32
Namespace for classes and interfaces for the Remote Service Call implementation
Root namespace for the PLCnext API