PLCnext API Documentation 25.0.2.69
IPayload.hpp
1
2//
3// Copyright Phoenix Contact GmbH & Co. KG
4//
6
7#pragma once
8
10#include "Arp/System/Nm/NotificationManagerTypes.hpp"
11
12
13namespace Arp { namespace System { namespace Nm
14{
15
16
18class ARP_CXX_SYMBOL_EXPORT IPayload
19{
20public:
21 virtual ~IPayload() = default;
22
24 virtual PayloadTypeIdType GetId() const = 0;
25
27 virtual const String GetName() const = 0;
28
31 virtual const RawPayloadType& GetAsRawPayloadType() const = 0;
32
34 virtual const String ToString() const = 0;
35};
36
37
38}}} // end of namespace Arp::System::Nm
This class represents the Arp String. The implementation is based on std::string.
Definition: String.hpp:39
Interface for Paylo objects
Definition: IPayload.hpp:19
virtual const String ToString() const =0
Get a human readable string representation
virtual const RawPayloadType & GetAsRawPayloadType() const =0
Returns a reference to the raw payload object
virtual PayloadTypeIdType GetId() const =0
Returns the PayloadTypeId
virtual const String GetName() const =0
Returns the PayloadTypeName
std::vector< Arp::Base::Rsc::Commons::RscVariant< RawPayloadTypeLength > > RawPayloadType
type for the internally transferred payloads
Definition: NotificationManagerTypes.hpp:32
Root namespace for the PLCnext API