Open Lighting Architecture: ola::rdm::UIDAllocator Class Reference

| Open Lighting Architecture 0.10.9

Loading...
Searching...
No Matches
Public Member Functions | List of all members
ola::rdm::UIDAllocator Class Reference
RDM » UID

## Detailed Description

Allocate UIDs from a pool.

Given a starting UID, this returns successive UIDs until the manufacturer range is exhausted.

## Public Member Functions
| UIDAllocator (const UID &uid)
| Create a new allocator with the starting UID.
| UIDAllocator (const UID &uid, uint32_t last_device_id)
| Create a new allocator with the starting UID that ends at the specified last_device_id.
UID * | AllocateNext ()
| Allocate the next UID from the pool.

## Constructor & Destructor Documentation

## ◆ UIDAllocator() [1/2]

ola::rdm::UIDAllocator::UIDAllocator | ( | const UID & | uid | ) |
| inlineexplicit

Create a new allocator with the starting UID.

Parameters

  uid | the first UID to allocate.

## ◆ UIDAllocator() [2/2]

ola::rdm::UIDAllocator::UIDAllocator | ( | const UID & | uid,
|  | uint32_t | last_device_id )
| inline

Create a new allocator with the starting UID that ends at the specified last_device_id.

Parameters

  uid | the first UID to allocate.
  last_device_id | the last device_id to use.

## Member Function Documentation

## ◆ AllocateNext()

UID * ola::rdm::UIDAllocator::AllocateNext | ( |  | ) |
| inline

Allocate the next UID from the pool.

Returns
  a new UID object, or NULL if the pool is empty. Ownership of the UID object is transferred to the caller.

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

- include/ola/rdm/UIDAllocator.h