Class IoT::Devices::IDeviceTree

File Information

Library: IoT/Devices
Package: Generated
Header: IoT/Devices/IDeviceTree.h

Description

This class manages a hierarchical structure of devices, consisting of Composite and leaf Device objects.

Inheritance

Direct Base Classes: Poco::OSP::Service

All Base Classes: Poco::OSP::Service, Poco::RefCountedObject

Known Derived Classes: DeviceTreeRemoteObject

Member Summary

Member Functions: deviceById, deviceByPath, findDeviceById, findDeviceByPath, isA, remoting__typeId, type

Inherited Functions: duplicate, isA, referenceCount, release, type

Types Aliases

Ptr

using Ptr = Poco::AutoPtr < IDeviceTree >;

Constructors

Destructor

~IDeviceTree

virtual ~IDeviceTree();

Destroys the IDeviceTree.

Member Functions

deviceById

virtual IoT::Devices::DeviceNode deviceById(
const std::string & id
) const = 0;

Returns the DeviceNode of the device with the given device identifier.

Throws a Poco::NotFoundException if no DeviceNode is available for the given device identifier.

deviceByPath

virtual IoT::Devices::DeviceNode deviceByPath(
const std::string & path
) const = 0;

Returns the DeviceNode of the device with the given path. The path name is composed of the instance names of all parent composite devices, as well as the device's instance name, separated by "/".

To obtain the root device, which is always a Composite, specify "/" or "" as pathName.

Throws a Poco::NotFoundException if no DeviceNode is available for the given pathName.

findDeviceById

virtual Poco::Optional < IoT::Devices::DeviceNode > findDeviceById(
const std::string & id
) const = 0;

Returns the DeviceNode of the device with the given device identifier, if it exists.

findDeviceByPath

virtual Poco::Optional < IoT::Devices::DeviceNode > findDeviceByPath(
const std::string & path
) const = 0;

Returns the DeviceNode of the device with the given path, if it exists. The path name is composed of the instance names of all parent composite devices, as well as the device's instance name, separated by "/".

To obtain the root device, which is always a Composite, specify "/" or "" as pathName.

isA

bool isA(
const std::type_info & otherType
) const;

Returns true if the class is a subclass of the class given by otherType.

See also: Poco::OSP::Service::isA()

remoting__typeId

static const Poco::RemotingNG::Identifiable::TypeId & remoting__typeId();

Returns the TypeId of the class.

type

const std::type_info & type() const;

Returns the type information for the object's class.

See also: Poco::OSP::Service::type()