api_docs_2025-0/NotificationRegistrationInfo_8hpp_source.html

//

//  Copyright Phoenix Contact GmbH & Co. KG

//

#pragma once

#include "Arp/System/Core/Arp.h"

#include "Arp/System/Nm/NotificationManagerTypes.hpp"

#include "Arp/System/Nm/Services/NotificationRegistrationStatus.hpp"

#include "Arp/System/Nm/Services/Severity.hpp"

#include "Arp/Base/Rsc/Commons/Rsc.hpp"

#include "Arp/Base/Rsc/Commons/RscString.hxx"

#include "Arp/Base/Rsc/Commons/RscSerializable.hpp"


namespace Arp { namespace System { namespace Nm

{


class ARP_CXX_SYMBOL_EXPORT NotificationRegistrationInfo : public Arp::Base::Rsc::Commons::RscSerializable

{

public:

    NotificationRegistrationInfo() = default;


    NotificationRegistrationInfo(

        NotificationNameIdType notificationNameId, const String& notificationName);


    NotificationRegistrationInfo(NotificationNameIdType notificationNameId,

                                 const String& notificationName, const String& senderName, Severity severity,

                                 PayloadTypeIdType payloadTypeId, NotificationRegistrationStatus initialStatus);


    // Methods of RscSerializable

    void Serialize(Arp::Base::Rsc::Commons::Services::RscWriter& writer)const;

    void Deserialize(Arp::Base::Rsc::Commons::Services::RscReader& reader);

    static size_t GetFieldCount(void);


    NotificationNameIdType GetNotificationNameId() const;

    String GetNotificationName() const;

    String GetSenderName() const;

    Severity GetSeverity() const;

    PayloadTypeIdType GetPayloadTypeId() const;

    NotificationRegistrationStatus GetStatus() const;

    bool IsSubscribed() const;

    bool IsRegistered() const;

    bool IsUnRegistered() const;


    void SetStatusRegistered();

    void SetStatusUnregistered();


private:

    NotificationNameIdType NotificationNameId;

    Arp::Base::Rsc::Commons::RscVariant<512> NotificationName{""};

    Arp::Base::Rsc::Commons::RscVariant<512> SenderName{""};

    Severity severity = Severity::Internal;

    PayloadTypeIdType PayloadTypeId;

    NotificationRegistrationStatus Status = NotificationRegistrationStatus::Subscribed;

};


}}} // namespace Arp::System::Nm

Arp.h

Arp::Base::Core::String
This class represents the Arp String. The implementation is based on std::string.
Definition: String.hpp:39

Arp::Base::Rsc::Commons::RscSerializable
Any custom struct type which is intended to be marshalled in a Rsc serialization context,...
Definition: RscSerializable.hpp:35

Arp::Base::Rsc::Commons::RscVariant< 512 >

Arp::Base::Rsc::Commons::Services::RscReader
Reads marshaled data of RSC services.
Definition: RscReader.hpp:34

Arp::Base::Rsc::Commons::Services::RscWriter
Writes marshalled data of RSC services.
Definition: RscWriter.hpp:34

Arp::System::Nm::IdType< Arp::uint32, struct NotificationNameIdTag >

Arp::System::Nm::NotificationRegistrationInfo
Information about the registration of a Notification
Definition: NotificationRegistrationInfo.hpp:21

Arp::System::Nm::Severity
enum ARP_CXX_SYMBOL_EXPORT Severity
Enumeration of Severities for notifications
Definition: Severity.hpp:14

Arp::System::Nm::NotificationRegistrationStatus
enum ARP_CXX_SYMBOL_EXPORT NotificationRegistrationStatus
Enumeration to represent the status of the Notification
Definition: NotificationRegistrationStatus.hpp:14

Arp
Root namespace for the PLCnext API