IoT::Devices

class DeviceTreeRemoteObject

File Information

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

Description

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

Inheritance

Direct Base Classes: IDeviceTree, Poco::RemotingNG::RemoteObject

All Base Classes: IDeviceTree, Poco::OSP::Service, Poco::RefCountedObject, Poco::RemotingNG::Identifiable, Poco::RemotingNG::RemoteObject

Member Summary

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

Inherited Functions: deviceById, deviceByPath, duplicate, findDeviceById, findDeviceByPath, isA, mutex, referenceCount, release, remoting__enableRemoteEvents, remoting__getURI, remoting__hasEvents, remoting__objectId, remoting__setURI, remoting__typeId, type

Types Aliases

Ptr

using Ptr = Poco::AutoPtr < DeviceTreeRemoteObject >;

Constructors

DeviceTreeRemoteObject

DeviceTreeRemoteObject(
    const Poco::RemotingNG::Identifiable::ObjectId & oid,
    Poco::SharedPtr < IoT::Devices::DeviceTree > pServiceObject
);

Creates a DeviceTreeRemoteObject.

Destructor

~DeviceTreeRemoteObject virtual

virtual ~DeviceTreeRemoteObject();

Destroys the DeviceTreeRemoteObject.

Member Functions

deviceById virtual inline

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

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.

See also: IoT::Devices::IDeviceTree::deviceById()

deviceByPath virtual inline

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

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.

See also: IoT::Devices::IDeviceTree::deviceByPath()

findDeviceById virtual inline

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

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

See also: IoT::Devices::IDeviceTree::findDeviceById()

findDeviceByPath virtual inline

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

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.

See also: IoT::Devices::IDeviceTree::findDeviceByPath()

remoting__typeId virtual inline

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

Securely control IoT edge devices from anywhere   Connect a Device