GuidConverter.h

Go to the documentation of this file.

/*
 *
 *
 * Distributed under the OpenDDS License.
 * See: http://www.opendds.org/license.html
 */

#ifndef OPENDDS_DCPS_GUIDCONVERTER_H
#define OPENDDS_DCPS_GUIDCONVERTER_H

#include "dcps_export.h"
#include "Definitions.h"
#include "SafetyProfileStreams.h"
#include "PoolAllocator.h"
#include "GuidUtils.h"

#include <dds/DdsDcpsGuidC.h>

OPENDDS_BEGIN_VERSIONED_NAMESPACE_DECL

namespace OpenDDS {
namespace DCPS {

/**
 * @class GuidConverter
 *
 * @brief Conversion processing and value testing utilities for RTPS
 *        GUID_t types.
 *
 * This class encapsulates the conversion of a GUID_t value to and from
 * other types used within OpenDDS.  This class handles opaque GUID_t values
 * only.  For specific access, the appropriate subclass must instead be used.
 *
 * Since the GUID_t type is formed of octets in network order, we do all
 * processing byte by byte to avoid any endian issues.
 *
 * Currently the GUID_t is mapped from various internal values.
 * These mappings are:
 *
 * byte  structure reference     content
 * ---- ---------------------    --------------------------
 *   0  GUID_t.guidPrefix[ 0] == VendorId_t == 0x01 for OCI (used for OpenDDS)
 *   1  GUID_t.guidPrefix[ 1] == VendorId_t == 0x03 for OCI (used for OpenDDS)
 *   2  GUID_t.guidPrefix[ 2] == 0x00
 *   3  GUID_t.guidPrefix[ 3] == 0x00
 *
 *   4  GUID_t.guidPrefix[ 4] == <private> (MS byte)
 *   5  GUID_t.guidPrefix[ 5] == <private>
 *   6  GUID_t.guidPrefix[ 6] == <private>
 *   7  GUID_t.guidPrefix[ 7] == <private> (LS byte)
 *
 *   8  GUID_t.guidPrefix[ 8] == <private> (MS byte)
 *   9  GUID_t.guidPrefix[ 9] == <private>
 *  10  GUID_t.guidPrefix[10] == <private>
 *  11  GUID_t.guidPrefix[11] == <private> (LS byte)
 *
 *  12  GUID_t.entityId.entityKey[ 0] == entity id[0] (MS byte)
 *  13  GUID_t.entityId.entityKey[ 1] == entity id[1]
 *  14  GUID_t.entityId.entityKey[ 2] == entity id[2] (LS byte)
 *  15  GUID_t.entityId.entityKind    == entity kind
 */
class OpenDDS_Dcps_Export GuidConverter {
public:
  /// Construct from a GUID_t.
  GuidConverter(const GUID_t& guid);

  /// Virtual destructor (this is a base class).
  virtual ~GuidConverter();

  /// Calculate the CRC32 checksum.
  long checksum() const;

  /// Extract the VendorId value.
  long vendorId() const;

  /// Extract the EntityId value.
  long entityId() const;

  /// Extract the EntityKey value.
  long entityKey() const;

  /// Extract the EntityKind value.
  EntityKind entityKind() const;

  /// Returns true if the GUID represents a builtin type domain entity.
  bool isBuiltinDomainEntity() const;

  /// Returns true if the GUID represents a user defined type domain entity.
  bool isUserDomainEntity() const;

  /// Returns true if the GUID represents a writer entity.
  bool isWriter() const;

  /// Returns true if the GUID represents a reader entity.
  bool isReader() const;

  /// Returns true if the GUID represents a topic entity.
  bool isTopic() const;

  /// Convert to diagnostic string.
  operator OPENDDS_STRING() const;
#ifdef DDS_HAS_WCHAR
  operator std::wstring() const;
#endif

  OPENDDS_STRING uniqueParticipantId() const;

protected:
  const GUID_t guid_;
};

struct OpenDDS_Dcps_Export LogGuid {
  explicit LogGuid(const GUID_t& id)
    : conv_(GuidConverter(id)) {}
  explicit LogGuid(const GuidPrefix_t& prefix)
    : conv_(GuidConverter(make_part_guid(prefix)))
  {
  }
  const char* c_str() const { return conv_.c_str(); }
  OPENDDS_STRING conv_;
};

#ifndef OPENDDS_SAFETY_PROFILE
OpenDDS_Dcps_Export std::ostream&
operator<<(std::ostream& os, const OpenDDS::DCPS::GuidConverter& rhs);

#ifdef DDS_HAS_WCHAR
OpenDDS_Dcps_Export std::wostream&
operator<<(std::wostream& os, const OpenDDS::DCPS::GuidConverter& rhs);
#endif //DDS_HAS_WCHAR
#endif //OPENDDS_SAFETY_PROFILE

} // namespace DCPS
} // namespace OpenDDS

OPENDDS_END_VERSIONED_NAMESPACE_DECL

#endif /* DCPS_GUIDCONVERTER_H */