AlarmAccess.hpp

 
//
//  Copyright PHOENIX CONTACT Electronics GmbH
//
#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;
};
 
// inline methods of class AlarmAccess
 
}}}}