mirror of https://github.com/nymea/nymea.git
134 lines
4.7 KiB
C++
134 lines
4.7 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 nymea. *
|
|
* *
|
|
* 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 DeviceDescriptor
|
|
\brief Holds the description of a \l{Device}.
|
|
|
|
\ingroup devices
|
|
\inmodule libnymea
|
|
|
|
An DeviceDescriptor describes an \l{Device} in order to match it with a \l{nymeaserver::Rule}.
|
|
|
|
\sa Device
|
|
*/
|
|
|
|
|
|
#include "devicedescriptor.h"
|
|
|
|
|
|
/*! Construct a DeviceDescriptor. */
|
|
DeviceDescriptor::DeviceDescriptor():
|
|
m_id(DeviceDescriptorId::createDeviceDescriptorId())
|
|
{
|
|
|
|
}
|
|
|
|
/*! Construct a DeviceDescriptor with the given \a deviceClassId, \a title, \a description and \a parentDeviceId.*/
|
|
DeviceDescriptor::DeviceDescriptor(const DeviceClassId &deviceClassId, const QString &title, const QString &description, const DeviceId &parentDeviceId):
|
|
m_id(DeviceDescriptorId::createDeviceDescriptorId()),
|
|
m_deviceClassId(deviceClassId),
|
|
m_title(title),
|
|
m_description(description),
|
|
m_parentDeviceId(parentDeviceId)
|
|
{
|
|
|
|
}
|
|
|
|
/*! Construct a DeviceDescriptor with the given \a id, \a deviceClassId, \a title, \a description and \a parentDeviceId.*/
|
|
DeviceDescriptor::DeviceDescriptor(const DeviceDescriptorId &id, const DeviceClassId &deviceClassId, const QString &title, const QString &description, const DeviceId &parentDeviceId) :
|
|
m_id(id),
|
|
m_deviceClassId(deviceClassId),
|
|
m_title(title),
|
|
m_description(description),
|
|
m_parentDeviceId(parentDeviceId)
|
|
{
|
|
}
|
|
|
|
/*! Returns true, if this DeviceDescriptor is valid. A DeviceDescriptor is valid, if the id and the deviceClassId are set.
|
|
* \sa id(), deviceClassId(), */
|
|
bool DeviceDescriptor::isValid() const
|
|
{
|
|
return !m_id.isNull() && !m_deviceClassId.isNull();
|
|
}
|
|
|
|
/*! Returns the id of this DeviceDescriptor. */
|
|
DeviceDescriptorId DeviceDescriptor::id() const
|
|
{
|
|
return m_id;
|
|
}
|
|
|
|
/*! Returns the deviceClassId of this DeviceDescriptor. */
|
|
DeviceClassId DeviceDescriptor::deviceClassId() const
|
|
{
|
|
return m_deviceClassId;
|
|
}
|
|
|
|
/*! Returns the name of this DeviceDescriptor. */
|
|
QString DeviceDescriptor::title() const
|
|
{
|
|
return m_title;
|
|
}
|
|
|
|
/*! Sets the \a title of this DeviceDescriptor. */
|
|
void DeviceDescriptor::setTitle(const QString &title)
|
|
{
|
|
m_title = title;
|
|
}
|
|
|
|
/*! Returns the description of this DeviceDescriptor. */
|
|
QString DeviceDescriptor::description() const
|
|
{
|
|
return m_description;
|
|
}
|
|
|
|
/*! Sets the \a description of this DeviceDescriptor. */
|
|
void DeviceDescriptor::setDescription(const QString &description)
|
|
{
|
|
m_description = description;
|
|
}
|
|
|
|
/*! Returns the parent device id for devices created from this DeviceDescriptor. */
|
|
DeviceId DeviceDescriptor::parentDeviceId() const
|
|
{
|
|
return m_parentDeviceId;
|
|
}
|
|
|
|
/*! Sets the parent device Id \a parentDeviceId for devices created from this DeviceDescriptor. */
|
|
void DeviceDescriptor::setParentDeviceId(const DeviceId &parentDeviceId)
|
|
{
|
|
m_parentDeviceId = parentDeviceId;
|
|
}
|
|
|
|
/*! Returns the list of \l{Param}{Params} of this DeviceDescriptor. */
|
|
ParamList DeviceDescriptor::params() const
|
|
{
|
|
return m_params;
|
|
}
|
|
|
|
/*! Sets the list of \l{Param}{Params} of this DeviceDescriptor with the given \a params. */
|
|
void DeviceDescriptor::setParams(const ParamList ¶ms)
|
|
{
|
|
m_params = params;
|
|
}
|