unique_id.h

Go to the documentation of this file.

/* -*- mode: C++ -*- */
/*********************************************************************
* Software License Agreement (BSD License)
*
*  Copyright (C) 2012 Jack O'Quin
*  All rights reserved.
*
*  Redistribution and use in source and binary forms, with or without
*  modification, are permitted provided that the following conditions
*  are met:
*
*   * Redistributions of source code must retain the above copyright
*     notice, this list of conditions and the following disclaimer.
*   * Redistributions in binary form must reproduce the above
*     copyright notice, this list of conditions and the following
*     disclaimer in the documentation and/or other materials provided
*     with the distribution.
*   * Neither the name of the author nor other contributors may be
*     used to endorse or promote products derived from this software
*     without specific prior written permission.
*
*  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
*  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
*  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
*  FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
*  COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
*  INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
*  BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
*  LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
*  CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
*  LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
*  ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
*  POSSIBILITY OF SUCH DAMAGE.
*********************************************************************/

#ifndef _IMPL_UNIQUE_ID_H_
#define _IMPL_UNIQUE_ID_H_ 1

#include <ros/ros.h>

#include <boost/uuid/uuid_generators.hpp>

namespace unique_id
{

  namespace impl
  {
    /* Instantiate boost string UUID generator. */
    static boost::uuids::string_generator genString;

    /* Instantiate boost random UUID generator. */
    static boost::uuids::random_generator genRandom;

    /* RFC 4122 namespace for URL identifiers. */
    static const std::string url_namespace =
      "6ba7b811-9dad-11d1-80b4-00c04fd430c8";

    /* RFC 4122 UUID for URL identifiers. */
    static const boost::uuids::uuid url_namespace_uuid =
      genString(url_namespace);

    /* Instantiate boost URL name UUID generator. */
    static boost::uuids::name_generator genURL(url_namespace_uuid);

    /* Generate RFC4122 Version 1 Time-Based UUID */
    static boost::uuids::uuid genTime(ros::Time uuid_time, uint64_t hw_addr)
    {
      // Get no. of 100 nanosecond intervals since 00:00:00 October 15, 1582
      // The RFC4122 standard only requires the least significant 60 bits for timestamp

      // No. of 100 ns intervals between 00:00:00 Oct 15, 1582 and 00:00:00 Jan 1, 1970
      uint64_t offset = 122192928000000000;

      uint64_t num_hundred_epoch = static_cast<uint64_t>(uuid_time.sec) / (1e-9 * 100) +
                                   static_cast<uint64_t>(uuid_time.nsec) / 100;
      // Note: Adding offset in the same line as the above statement may yield incorrect
      //       values on some systems
      uint64_t num_hundred_rfc = num_hundred_epoch + offset;

      uint32_t time_low = static_cast<uint32_t>(num_hundred_rfc);
      uint16_t time_mid = static_cast<uint16_t>(num_hundred_rfc >> 32);
      uint16_t version = 0x1000;
      uint16_t time_hi_and_version = static_cast<uint16_t>(num_hundred_rfc >> (32 + 16)) | version;

      // Generate Clock Sequence ID based on random number
      uint16_t clock_seq_and_reserved = (rand() % (1 << 14)) | 0x8000;

      boost::uuids::uuid uu = {
                                static_cast<uint8_t>(time_low >> 24), static_cast<uint8_t>(time_low >> 16),
                                static_cast<uint8_t>(time_low >> 8),  static_cast<uint8_t>(time_low),
                                static_cast<uint8_t>(time_mid >> 8),  static_cast<uint8_t>(time_mid),
                                static_cast<uint8_t>(time_hi_and_version >> 8),
                                static_cast<uint8_t>(time_hi_and_version),
                                static_cast<uint8_t>(clock_seq_and_reserved >> 8),
                                static_cast<uint8_t>(clock_seq_and_reserved),
                                static_cast<uint8_t>(hw_addr >> 40), static_cast<uint8_t>(hw_addr >> 32),
                                static_cast<uint8_t>(hw_addr >> 24), static_cast<uint8_t>(hw_addr >> 16),
                                static_cast<uint8_t>(hw_addr >> 8),  static_cast<uint8_t>(hw_addr)
                              };
      return uu;
    }

  } // end namespace impl

} // end namespace unique_id

#endif // _IMPL_UNIQUE_ID_H_