/usr/include/ola/rdm/UIDAllocator.h is in libola-dev 0.9.8-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 | /*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*
* UIDAllocator.h
* A class to allocate UIDs
* Copyright (C) 2013 Simon Newton
*/
/**
* @addtogroup rdm_uid
* @{
* @file UIDAllocator.h
* @brief A class to allocate UIDs
* @}
*/
#ifndef INCLUDE_OLA_RDM_UIDALLOCATOR_H_
#define INCLUDE_OLA_RDM_UIDALLOCATOR_H_
#include <ola/rdm/UID.h>
namespace ola {
namespace rdm {
/**
* @addtogroup rdm_uid
* @{
* @class UIDAllocator
* @brief Allocate UIDs from a pool.
*
* Given a starting UID, this returns successive UIDs until the manufacturer
* range is exhausted.
* @}
*/
class UIDAllocator {
public:
/**
* @brief Create a new allocator with the starting UID.
* @param uid the first UID to allocate.
*/
explicit UIDAllocator(const UID &uid)
: m_esta_id(uid.ManufacturerId()),
m_device_id(uid.DeviceId()),
m_last_device_id(UID::ALL_DEVICES) {
}
/**
* @brief Create a new allocator with the starting UID that ends at the
* specified last_device_id.
* @param uid the first UID to allocate.
* @param last_device_id the last device_id to use.
*/
UIDAllocator(const UID &uid, uint32_t last_device_id)
: m_esta_id(uid.ManufacturerId()),
m_device_id(uid.DeviceId()),
m_last_device_id(last_device_id) {
}
/**
* @brief 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.
*/
UID *AllocateNext() {
if (m_device_id == UID::ALL_DEVICES || m_device_id > m_last_device_id)
return NULL;
return new UID(m_esta_id, m_device_id++);
}
private:
uint16_t m_esta_id;
uint32_t m_device_id;
uint32_t m_last_device_id;
};
} // namespace rdm
} // namespace ola
#endif // INCLUDE_OLA_RDM_UIDALLOCATOR_H_
|