OpenDDS::DCPS::GuidConverter Class Reference

Conversion processing and value testing utilities for RTPS GUID_t types. More...

#include <GuidConverter.h>

Inheritance diagram for OpenDDS::DCPS::GuidConverter:

[legend]Collaboration diagram for OpenDDS::DCPS::GuidConverter:

[legend]List of all members.

Public Member Functions
	GuidConverter (const GUID_t &guid)
	Construct from a GUID_t.
virtual	~GuidConverter ()
	Virtual destructor (this is a base class).
long	checksum () const
	Calculate the CRC32 checksum.
long	vendorId () const
	Extract the VendorId value.
long	entityId () const
	Extract the EntityId value.
long	entityKey () const
	Extract the EntityKey value.
EntityKind	entityKind () const
	Extract the EntityKind value.
	operator std::string () const
	Convert to diagnostic string.
Protected Attributes
const GUID_t	guid_

---

Detailed Description

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 == 0x00 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

---

Constructor & Destructor Documentation

OpenDDS::DCPS::GuidConverter::GuidConverter

(

const GUID_t &

guid

)

Construct from a GUID_t.

OpenDDS::DCPS::GuidConverter::~GuidConverter

(

)

[virtual]

Virtual destructor (this is a base class).

---

Member Function Documentation

long OpenDDS::DCPS::GuidConverter::checksum

(

)

const

Calculate the CRC32 checksum.

long OpenDDS::DCPS::GuidConverter::entityId

(

)

const

Extract the EntityId value.

long OpenDDS::DCPS::GuidConverter::entityKey

(

)

const

Extract the EntityKey value.

EntityKind OpenDDS::DCPS::GuidConverter::entityKind

(

)

const

Extract the EntityKind value.

OpenDDS::DCPS::GuidConverter::operator std::string

(

)

const

Convert to diagnostic string.

long OpenDDS::DCPS::GuidConverter::vendorId

(

)

const

Extract the VendorId value.

---

Member Data Documentation

const GUID_t OpenDDS::DCPS::GuidConverter::guid_ [protected]

---

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

• GuidConverter.h
• GuidConverter.cpp

---