uuid.h

Go to the documentation of this file.

/*
 * Copyright (c) 2010, Willow Garage, Inc.
 * 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 Willow Garage, Inc. nor the names of its
 *       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 RVIZ_COMMON_UUID_H
#define RVIZ_COMMON_UUID_H

#include <boost/array.hpp>
#include <ros/types.h>
#include <ros/message_forward.h>
#include <iostream>

namespace rve_msgs
{
ROS_DECLARE_MESSAGE(UUID);
}

namespace rve_common
{

class UUID
{
public:
  static UUID Null;
  static UUID generate();

  UUID();
  UUID(const rve_msgs::UUID&);

  UUID& operator=(const rve_msgs::UUID&);
  operator rve_msgs::UUID() const;

  bool operator<(const UUID& rhs) const;
  bool operator==(const UUID& rhs) const;
  bool operator!=(const UUID& rhs) const { return !(*this == rhs); }

  std::string toString() const;
  void fromString(const std::string& str);

  bool isNull() const;

private:
  boost::array<uint8_t, 16> data_;
};

std::ostream& operator<<(std::ostream& o, const UUID& u);
std::istream& operator>>(std::istream& i, UUID& u);

std::size_t hash_value(const UUID &uuid);

} // namespace rve_common

#endif // RVIZ_COMMON_UUID_H