GenericPayload.hpp

 
//
//  Copyright Phoenix Contact GmbH & Co. KG
//
 
#pragma once
 
#include "Arp/System/Core/Arp.h"
#include "Arp/System/Nm/IPayload.hpp"
#include "Arp/System/Nm/Notification.hpp"
 
 
namespace Arp { namespace System { namespace Nm
{
 
 
class ARP_CXX_SYMBOL_EXPORT GenericPayload : public IPayload
{
public: // typedefs
    using ValueType = RawPayloadType::value_type;
    using FieldType = Arp::Base::Rsc::Commons::RscType;
 
private: // typedefs
    using FieldInfos = std::vector<FieldType>;
 
public: // construction/destruction
    explicit GenericPayload(const Notification& notification);
    GenericPayload(PayloadTypeIdType id, const String& name);
    GenericPayload(PayloadTypeIdType id, const String& name, const RawPayloadType& payloadArg);
    GenericPayload(PayloadTypeIdType id, const String& name, const Notification& notification);
    ~GenericPayload() override = default;
 
public: // operations
    // Methods of IPayload
    PayloadTypeIdType     GetId() const override;
    const String          GetName() const override;
    const RawPayloadType& GetAsRawPayloadType() const override;
    const String          ToString() const override;
    RawPayloadType&& MoveOutRawPayload();
    bool IsReadOnly() const;
    size_t GetFieldCount() const;
    const ValueType& GetFieldValue(size_t fieldIndex) const;
    FieldType GetFieldType(size_t fieldIndex) const;
    size_t GetFieldIndexFormatString() const;
    size_t AddField(FieldType type);
    void   SetFieldValue(size_t fieldIndex, const ValueType& value);
 
private: // methods
    void         InitializeFields();
    bool         HasAssociatedNotification() const;
    bool         CanFieldBeAdded() const;
    const String FormatValue(const String& formatString, const ValueType& value) const;
 
private: // fields
    PayloadTypeIdType   Id;
    String              Name;
    const Notification* NotificationPtr = nullptr;
    RawPayloadType      Payload;
    FieldInfos          Fields;
    size_t              FieldIndexFormatString = 0;
};
 
 
}}} // end of namespace Arp::System::Nm