hyperion.ng/include/hyperion/PriorityMuxer.h

132 lines
3.3 KiB
C
Raw Normal View History

#pragma once
// STL includes
#include <vector>
#include <map>
#include <cstdint>
#include <limits>
// QT includes
#include <QMap>
// Utils includes
#include <utils/ColorRgb.h>
#include <utils/Components.h>
2013-09-06 21:26:58 +02:00
///
/// The PriorityMuxer handles the priority channels. Led values input is written to the priority map
/// and the muxer keeps track of all active priorities. The current priority can be queried and per
/// priority the led colors.
///
class PriorityMuxer
{
public:
2013-09-06 21:26:58 +02:00
///
/// The information structure for a single priority channel
///
struct InputInfo
{
2013-09-06 21:26:58 +02:00
/// The priority of this channel
int priority;
2013-09-06 21:26:58 +02:00
/// The absolute timeout of the channel
int64_t timeoutTime_ms;
2013-09-06 21:26:58 +02:00
/// The colors for each led of the channel
std::vector<ColorRgb> ledColors;
/// The component
hyperion::Components componentId;
/// Who set it
QString origin;
};
/// The lowest possible priority, which is used when no priority channels are active
const static int LOWEST_PRIORITY = std::numeric_limits<uint8_t>::max();
2013-09-06 21:26:58 +02:00
///
/// Constructs the PriorityMuxer for the given number of leds (used to switch to black when
/// there are no priority channels
///
/// @param ledCount The number of leds
///
2013-08-18 13:33:56 +02:00
PriorityMuxer(int ledCount);
2013-09-06 21:26:58 +02:00
///
/// Destructor
///
~PriorityMuxer();
2013-09-06 21:26:58 +02:00
///
/// Returns the current priority
///
/// @return The current priority
///
int getCurrentPriority() const;
2013-09-06 21:26:58 +02:00
///
/// Returns the state (enabled/disabled) of a specific priority channel
/// @param priority The priority channel
/// @return True if the priority channel exists else false
///
bool hasPriority(const int priority) const;
2013-09-06 21:26:58 +02:00
///
/// Returns the number of active priorities
///
/// @return The list with active priorities
///
QList<int> getPriorities() const;
2013-09-06 21:26:58 +02:00
///
/// Returns the information of a specified priority channel
///
/// @param priority The priority channel
///
/// @return The information for the specified priority channel
///
/// @throws std::runtime_error if the priority channel does not exist
///
const InputInfo& getInputInfo(const int priority) const;
2013-09-06 21:26:58 +02:00
///
/// Sets/Updates the data for a priority channel
///
/// @param[in] priority The priority of the channel
/// @param[in] ledColors The led colors of the priority channel
/// @param[in] timeoutTime_ms The absolute timeout time of the channel
/// @param[in] component The component of the channel
/// @param[in] origin Who set the channel
2013-09-06 21:26:58 +02:00
///
void setInput(const int priority, const std::vector<ColorRgb>& ledColors, const int64_t timeoutTime_ms=-1, hyperion::Components component=hyperion::COMP_INVALID, const QString origin="System");
2013-09-06 21:26:58 +02:00
///
/// Clears the specified priority channel
///
/// @param[in] priority The priority of the channel to clear
///
void clearInput(const int priority);
2013-09-06 21:26:58 +02:00
///
/// Clears all priority channels
///
void clearAll();
2013-09-06 21:26:58 +02:00
///
/// Updates the current time. Channels with a configured time out will be checked and cleared if
/// required.
///
/// @param[in] now The current time
///
void setCurrentTime(const int64_t& now);
private:
2013-09-06 21:26:58 +02:00
/// The current priority (lowest value in _activeInputs)
2013-08-18 13:33:56 +02:00
int _currentPriority;
2013-09-06 21:26:58 +02:00
/// The mapping from priority channel to led-information
2013-08-18 13:33:56 +02:00
QMap<int, InputInfo> _activeInputs;
2013-09-06 21:26:58 +02:00
/// The information of the lowest priority channel
2013-08-18 13:33:56 +02:00
InputInfo _lowestPriorityInfo;
};