• DeviceDescriptor
  • DeviceDescriptor Class

    Holds the description of a Device. More...

    Header: #include <DeviceDescriptor>

    Public Functions

    DeviceDescriptor()
    DeviceDescriptor(const DeviceClassId & deviceClassId, const QString & title = QString(), const QString & description = QString(), const DeviceId & parentDeviceId = DeviceId())
    DeviceDescriptor(const DeviceDescriptorId & id, const DeviceClassId & deviceClassId, const QString & title = QString(), const QString & description = QString(), const DeviceId & parentDeviceId = DeviceId())
    QString description() const
    DeviceClassId deviceClassId() const
    DeviceDescriptorId id() const
    bool isValid() const
    ParamList params() const
    DeviceId parentDeviceId() const
    void setDescription(const QString & description)
    void setParams(const ParamList & params)
    void setParentDeviceId(const DeviceId & parentDeviceId)
    void setTitle(const QString & title)
    QString title() const

    Detailed Description

    Holds the description of a Device.

    An DeviceDescriptor describes an Device in order to match it with a nymeaserver::Rule.

    See also Device.

    Member Function Documentation

    DeviceDescriptor::DeviceDescriptor()

    Construct a DeviceDescriptor.

    DeviceDescriptor::DeviceDescriptor(const DeviceClassId & deviceClassId, const QString & title = QString(), const QString & description = QString(), const DeviceId & parentDeviceId = DeviceId())

    Construct a DeviceDescriptor with the given deviceClassId, title, description and parentDeviceId.

    DeviceDescriptor::DeviceDescriptor(const DeviceDescriptorId & id, const DeviceClassId & deviceClassId, const QString & title = QString(), const QString & description = QString(), const DeviceId & parentDeviceId = DeviceId())

    Construct a DeviceDescriptor with the given id, deviceClassId, title, description and parentDeviceId.

    QString DeviceDescriptor::description() const

    Returns the description of this DeviceDescriptor.

    See also setDescription().

    DeviceClassId DeviceDescriptor::deviceClassId() const

    Returns the deviceClassId of this DeviceDescriptor.

    DeviceDescriptorId DeviceDescriptor::id() const

    Returns the id of this DeviceDescriptor.

    bool DeviceDescriptor::isValid() const

    Returns true, if this DeviceDescriptor is valid. A DeviceDescriptor is valid, if the id and the deviceClassId are set.

    See also id() and deviceClassId().

    ParamList DeviceDescriptor::params() const

    Returns the list of Params of this DeviceDescriptor.

    See also setParams().

    DeviceId DeviceDescriptor::parentDeviceId() const

    Returns the parent device id for devices created from this DeviceDescriptor.

    See also setParentDeviceId().

    void DeviceDescriptor::setDescription(const QString & description)

    Sets the description of this DeviceDescriptor.

    See also description().

    void DeviceDescriptor::setParams(const ParamList & params)

    Sets the list of Params of this DeviceDescriptor with the given params.

    See also params().

    void DeviceDescriptor::setParentDeviceId(const DeviceId & parentDeviceId)

    Sets the parent device Id for devices created from this DeviceDescriptor.

    See also parentDeviceId().

    void DeviceDescriptor::setTitle(const QString & title)

    Sets the title of this DeviceDescriptor.

    See also title().

    QString DeviceDescriptor::title() const

    Returns the name of this DeviceDescriptor.

    See also setTitle().