guh - Developer documentation

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())
DeviceDescriptor(const DeviceDescriptorId & id, const DeviceClassId & deviceClassId, const QString & title = QString(), const QString & description = QString())
QString description() const
DeviceClassId deviceClassId() const
DeviceDescriptorId id() const
bool isValid() const
ParamList params() const
void setDescription(const QString & description)
void setParams(const ParamList & params)
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 guhserver::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())

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

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

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

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().

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::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().