Hue::Device::Enumerator Class Reference

Abstract class to manage a list of devices. More...

#include <Device.h>

Inheritance diagram for Hue::Device::Enumerator:
Collaboration diagram for Hue::Device::Enumerator:

Public Member Functions

virtual Devicefind (Device::ID id)
 Lookup device by ID. More...
 
virtual Devicefind (const String &name)
 Lookup device by name. More...
 
- Public Member Functions inherited from UPnP::Enumerator< Device, Enumerator >
virtual ~Enumerator ()
 
virtual Enumeratorclone ()=0
 Make a copy of this enumerator. More...
 
virtual void reset ()=0
 Reset enumerator to start of list. More...
 
virtual Devicecurrent ()=0
 Get the current item. More...
 
virtual Devicenext ()=0
 Get next item. More...
 

Detailed Description

Abstract class to manage a list of devices.

Note
Applications must provide an implementation of this for the bridge. Returned device objects may only be considered valid for the duration of the current task call as they may be destroyed at any time.

Member Function Documentation

◆ find() [1/2]

virtual Device* Hue::Device::Enumerator::find ( const String name)
virtual

Lookup device by name.

Return values
Device*nullptr if not found
Note
With default implementation, enumerator position is updated

◆ find() [2/2]

virtual Device* Hue::Device::Enumerator::find ( Device::ID  id)
virtual

Lookup device by ID.

Return values
Device*nullptr if not found
Note
With default implementation, enumerator position is updated

The documentation for this class was generated from the following file: