mirror of https://github.com/nymea/nymea.git
141 lines
4.5 KiB
C++
141 lines
4.5 KiB
C++
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
|
|
* *
|
|
* Copyright (C) 2015 Simon Stürz <simon.stuerz@guh.io> *
|
|
* Copyright (C) 2014 Michael Zanetti <michael_zanetti@gmx.net> *
|
|
* *
|
|
* This file is part of guh. *
|
|
* *
|
|
* This library is free software; you can redistribute it and/or *
|
|
* modify it under the terms of the GNU Lesser General Public *
|
|
* License as published by the Free Software Foundation; either *
|
|
* version 2.1 of the License, or (at your option) any later version. *
|
|
* *
|
|
* This library is distributed in the hope that it will be useful, *
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of *
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU *
|
|
* Lesser General Public License for more details. *
|
|
* *
|
|
* You should have received a copy of the GNU Lesser General Public *
|
|
* License along with this library; If not, see *
|
|
* <http://www.gnu.org/licenses/>. *
|
|
* *
|
|
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
|
|
|
|
/*!
|
|
\class EventType
|
|
\brief Describes a \l{Event} for a \l{Device}.
|
|
|
|
\ingroup guh-types
|
|
\inmodule libguh
|
|
|
|
\sa Event, EventDescriptor
|
|
*/
|
|
|
|
#include "eventtype.h"
|
|
|
|
/*! Constructs a EventType object with the given \a id. */
|
|
EventType::EventType(const EventTypeId &id):
|
|
m_id(id),
|
|
m_index(0),
|
|
m_ruleRelevant(true),
|
|
m_graphRelevant(false)
|
|
{
|
|
|
|
}
|
|
|
|
/*! Returns the id. */
|
|
EventTypeId EventType::id() const
|
|
{
|
|
return m_id;
|
|
}
|
|
|
|
/*! Returns the name of this EventType, e.g. "Temperature changed". */
|
|
QString EventType::name() const
|
|
{
|
|
return m_name;
|
|
}
|
|
|
|
/*! Set the name for this EventType to \a name, e.g. "Temperature changed". */
|
|
void EventType::setName(const QString &name)
|
|
{
|
|
m_name = name;
|
|
}
|
|
|
|
/*! Returns the index of this \l{EventType}. The index of an \l{EventType} indicates the order in the \l{DeviceClass}.
|
|
* This guarantees that a \l{Device} will look always the same (\l{Event} order). */
|
|
int EventType::index() const
|
|
{
|
|
return m_index;
|
|
}
|
|
|
|
/*! Set the \a index of this \l{EventType}. */
|
|
void EventType::setIndex(const int &index)
|
|
{
|
|
m_index = index;
|
|
}
|
|
|
|
/*! Holds a List describing possible parameters for a \l{Event} of this EventType.
|
|
* e.g. QList(ParamType("temperature", QVariant::Real)). */
|
|
QList<ParamType> EventType::paramTypes() const
|
|
{
|
|
return m_paramTypes;
|
|
}
|
|
|
|
/*! Set the parameter description for this EventType to \a paramTypes,
|
|
* e.g. QList<ParamType>() << ParamType("temperature", QVariant::Real)). */
|
|
void EventType::setParamTypes(const QList<ParamType> ¶mTypes)
|
|
{
|
|
m_paramTypes = paramTypes;
|
|
}
|
|
|
|
/*! Returns true if this EventType is relevant for the rule from a user perspective. */
|
|
bool EventType::ruleRelevant() const
|
|
{
|
|
return m_ruleRelevant;
|
|
}
|
|
|
|
/*! Sets this EventType relevant for the rule from a user perspective to \a ruleRelevant. */
|
|
void EventType::setRuleRelevant(const bool &ruleRelevant)
|
|
{
|
|
m_ruleRelevant = ruleRelevant;
|
|
}
|
|
|
|
/*! Returns true if this EventType is interesting to visualize the logs in a graph/chart from a user perspective. */
|
|
bool EventType::graphRelevant() const
|
|
{
|
|
return m_graphRelevant;
|
|
}
|
|
|
|
/*! Sets this EventType \a graphRelevant to inform the client application if this \l{EventType} is interesting to visualize the logs in a graph/chart. */
|
|
void EventType::setGraphRelevant(const bool &graphRelevant)
|
|
{
|
|
m_graphRelevant = graphRelevant;
|
|
}
|
|
|
|
EventTypes::EventTypes(const QList<EventType> &other)
|
|
{
|
|
foreach (const EventType &at, other) {
|
|
append(at);
|
|
}
|
|
}
|
|
|
|
EventType EventTypes::findByName(const QString &name)
|
|
{
|
|
foreach (const EventType &eventType, *this) {
|
|
if (eventType.name() == name) {
|
|
return eventType;
|
|
}
|
|
}
|
|
return EventType(EventTypeId());
|
|
}
|
|
|
|
EventType EventTypes::findById(const EventTypeId &id)
|
|
{
|
|
foreach (const EventType &eventType, *this) {
|
|
if (eventType.id() == id) {
|
|
return eventType;
|
|
}
|
|
}
|
|
return EventType(EventTypeId());
|
|
}
|