PLCnext API Documentation  22.9.0.33
ChannelInformation.hpp
1 //
3 // Copyright PHOENIX CONTACT Electronics GmbH
4 //
6 #pragma once
7 #include "Arp/System/Core/Arp.h"
8 #include "Arp/System/Rsc/Services/IRscSerializable.hpp"
9 #include "Arp/System/Rsc/Services/RscReader.hpp"
10 #include "Arp/System/Rsc/Services/RscString.hxx"
11 #include "Arp/System/Rsc/Services/RscWriter.hpp"
12 #include "Arp/System/Um/Services/MessageSecurityMode.hpp"
13 
14 // DO NOT MODIFY THIS FILE, THIS FILE IS AUTOGENERATED
15 
16 namespace Arp { namespace System { namespace Um { namespace Services
17 {
18 
19 using namespace Arp;
20 using namespace Arp::System::Rsc::Services;
21 
44 {
45 public:
53  uint32 GatewayID = 0;
54 
62 
66  MessageSecurityMode SecurityMode = static_cast<MessageSecurityMode>(0);
67 
68  void Serialize(RscWriter& writer)const override
69  {
70  writer.Write(this->GatewayID);
71  writer.Write(this->ProtocolObjectName);
72  writer.Write(this->SecurityMode);
73  }
74 
75  void Deserialize(RscReader& reader)override
76  {
77  reader.Read(this->GatewayID);
78  reader.Read(this->ProtocolObjectName);
79  reader.Read(this->SecurityMode);
80  }
81 
82  static constexpr size_t GetFieldCount(void)
83  {
84  return 3;
85  }
86 };
87 
88 }}}} // end of namespace Arp::System::Um::Services
Marshalls structure or class data types. Serialize and Deserialize have to marshal fields in the same...
Definition: IRscSerializable.hpp:19
Reads data from Rsc
Definition: RscReader.hpp:26
T Read(void)
Reads an element of T from Rsc. With data tagging enabled RscType of T is validated.
Definition: RscReader.hpp:165
Writes data to Rsc.
Definition: RscWriter.hpp:31
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:177
Describes an external channel at which the authentication of a user was requested.
Definition: ChannelInformation.hpp:44
void Serialize(RscWriter &writer) const override
Serializes the datatype. All fields of the datatype have to be serialized in use of RscWriter.
Definition: ChannelInformation.hpp:68
RscString< 512 > ProtocolObjectName
A human readable name which describes the protocol which the gateway talks with a remote instance whi...
Definition: ChannelInformation.hpp:61
void Deserialize(RscReader &reader) override
Deserializes the datatype. All fields of the datatype have to be deserialized in use of RscReader.
Definition: ChannelInformation.hpp:75
std::uint32_t uint32
The Arp unsigned integer type of 4 byte size.
Definition: PrimitiveTypes.hpp:35
@ System
System components used by the System, Device, Plc or Io domains.
Namespace for classes and interfaces for the Remote Service Call implementation
Definition: IRscReadEnumerator.hxx:10
MessageSecurityMode
Describes the security measures which are applied to messages transported via a channel.
Definition: MessageSecurityMode.hpp:26
Root namespace for the PLCnext API