alertServiceIf.hpp

Go to the documentation of this file.

#ifndef RTCTK_COMPONENTFRAMEWORK_ALERTSERVICEIF_HPP
#define RTCTK_COMPONENTFRAMEWORK_ALERTSERVICEIF_HPP
 
#include <string>
 
#include <rtctk/componentFramework/exceptions.hpp>
 
namespace rtctk::componentFramework {

class AlertConflictException : public RtctkException {
public:
    explicit AlertConflictException(const std::string& id);
};
 
class AlertStatus;

class AlertSource {
public:
    AlertSource();
    AlertSource(AlertStatus& status, const std::string& id, const std::string& text);

    ~AlertSource();

    AlertSource(const AlertSource& other) = delete;
    AlertSource& operator=(const AlertSource& other) = delete;

    AlertSource(AlertSource&& other) noexcept = default;

    AlertSource& operator=(AlertSource&& other) noexcept = default;

    const std::string& GetId() const;

    std::string GetText() const;

    void Set(bool state = true);

    void Clear();

    bool IsSet();
 
private:
    AlertStatus* m_status;
    std::string m_id;
};

class AlertServiceIf {
public:
    virtual ~AlertServiceIf() = default;

    virtual AlertSource MakeAlertSource(const std::string& id, const std::string& text) = 0;

    virtual bool GetStatus() = 0;

    virtual void ClearAll() = 0;
};
 
}  // namespace rtctk::componentFramework
 
#endif  // RTCTK_COMPONENTFRAMEWORK_ALERTSERVICEIF_HPP