api_docs_2025-0/AlarmAccess_8hpp_source.html

//

//  Copyright Phoenix Contact GmbH & Co. KG

//

#pragma once

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

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

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

#include "Arp/System/NmPayload/Alarms/Internal/AckConfPayload.hpp"

#include "Arp/System/NmPayload/Alarms/Internal/AlarmPayload.hpp"

#include <functional>


namespace Arp { namespace System { namespace NmPayload { namespace Alarms

{


constexpr int NotificationQueueOverflowError = 100;

constexpr int NotInitializedError = -1;

constexpr int InvalidArgumentError = -2;

constexpr int InvalidStateError = -2;

constexpr int InvalidAlarmIdError = -2;

constexpr int InvalidAlarmTypeError = -3;


using namespace Arp::System::NmPayload::Alarms::Internal;


class ARP_CXX_SYMBOL_EXPORT AlarmAccess

{

public: // usings

    using Mutex = Arp::System::Commons::Threading::Mutex;


public: // construction/destruction

    AlarmAccess();

    AlarmAccess(const AlarmAccess& arg) = delete;

    AlarmAccess& operator=(const AlarmAccess& arg) = delete;

    ~AlarmAccess(void);


public:

    int32 Init(String alarmClientId);

    void Dispose();

    int32 AddAlarm(AlarmState& alarmState);

    int32 NewAlarmState(AlarmState& alarmState);

    int32 Acknowledge(const String& alarmId);

    int32 AcknowledgeWithComment(const String& alarmId, const String& comment = "", const String& language = "", const String& user = "");

    int32 Confirm(const String& alarmId);

    int32 ConfirmWithComment(const String& alarmId, const String& comment = "", const String& language = "", const String& user = "");

    int32 AddComment(const String& alarmId, const String& comment, const String& language = "", const String& user = "");

    int32 SubscribeAddAlarm(std::function<void(const AlarmState& alarmState)> handler);

    int32 SubscribeNewAlarmState(std::function<void(const AlarmState& alarmState)> handler);

    int32 SubscribeAcknowledge(std::function<void(const String& alarmId, const String& comment, const String& language, const String& user)> handler);

    int32 SubscribeConfirm(std::function<void(const String& alarmId, const String& comment, const String& language, const String& user)> handler);

    int32 SubscribeAddComment(std::function<void(const String& alarmId, const String& comment, const String& language, const String& user)> handler);


private: // methods

    void AddAlarmNotificationReceived(const Notification& notification);

    void NewStateNotificationReceived(const Notification& notification);

    void AcknowledgeNotificationReceived(const Notification& notification);

    void ConfirmNotificationReceived(const Notification& notification);

    void AddCommentNotificationReceived(const Notification& notification);

private: // fields

    String alarmClientName;

    bool initialized;

    mutable Mutex alarmsMutex;

    NonBlockingNotificationRegistration<AlarmPayload> addAlarmPublisher;

    NonBlockingNotificationRegistration<AlarmPayload> newStatePublisher;

    NonBlockingNotificationRegistration<StringPayload> acknowledgePublisher1;

    NonBlockingNotificationRegistration<AckConfPayload> acknowledgePublisher2;

    NonBlockingNotificationRegistration<StringPayload> confirmPublisher1;

    NonBlockingNotificationRegistration<AckConfPayload> confirmPublisher2;

    NonBlockingNotificationRegistration<AckConfPayload> addCommentPublisher;

    NotificationSubscriber addAlarmSubscriber;

    NotificationSubscriber newStateSubscriber;

    //NotificationSubscriber acknowledgeSubscriber1;

    NotificationSubscriber acknowledgeSubscriber2;

    //NotificationSubscriber confirmSubscriber1;

    NotificationSubscriber confirmSubscriber2;

    NotificationSubscriber addCommentSubscriber;

    std::function<void(const AlarmState& alarmState)> addAlarmHandler;

    std::function<void(const AlarmState& alarmState)> newAlarmStateHandler;

    std::function<void(const String& alarmId, const String& comment, const String& language, const String& user)> acknowledgeHandler;

    std::function<void(const String& alarmId, const String& comment, const String& language, const String& user)> confirmHandler;

    std::function<void(const String& alarmId, const String& comment, const String& language, const String& user)> addCommentHandler;

};


}}}}

Arp.h

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

Arp::System::Commons::Threading::Mutex
Mutual exclusion object to prevent data from concurrent modifications.
Definition: Mutex.hpp:27

Arp::System::NmPayload::Alarms::AlarmAccess
Access class for the alarm server component.
Definition: AlarmAccess.hpp:46

Arp::System::NmPayload::Alarms::AlarmState
State with sub states of an alarm.
Definition: AlarmState.hpp:12

Arp::System::Nm::NonBlockingNotificationRegistration
Proxy object for a non-blocking NotificationRegistration
Definition: NonBlockingNotificationRegistration.hpp:35

Arp::System::Nm::NotificationSubscriber
Proxy class for an subscriber of notifications
Definition: NotificationSubscriber.hpp:30

Arp::System::Nm::Notification
Contains meta data and paylod of a Notification
Definition: Notification.hpp:20

Arp::Base::Core::int32
std::int32_t int32
The Arp integer type of 4 byte size.
Definition: PrimitiveTypes.hpp:35

Arp
Root namespace for the PLCnext API