OpenDDS  Snapshot(2023/04/07-19:43)
Public Member Functions | List of all members
OpenDDS::DCPS::RepoIdConverter Class Reference

Conversion processing and value testing utilities for DCPS Information Repository identifiers. More...

#include <RepoIdConverter.h>

Inheritance diagram for OpenDDS::DCPS::RepoIdConverter:
Inheritance graph
[legend]
Collaboration diagram for OpenDDS::DCPS::RepoIdConverter:
Collaboration graph
[legend]

Public Member Functions

 RepoIdConverter (const GUID_t &repoId)
 
 ~RepoIdConverter ()
 
OpenDDS::Federator::RepoKey federationId () const
 Get the federeation id from the GUID. More...
 
ParticipantId participantId () const
 Get the participant id from the GUID. More...
 
- Public Member Functions inherited from OpenDDS::DCPS::GuidConverter
 GuidConverter (const GUID_t &guid)
 Construct from a GUID_t. More...
 
virtual ~GuidConverter ()
 Virtual destructor (this is a base class). More...
 
long checksum () const
 Calculate the CRC32 checksum. More...
 
long vendorId () const
 Extract the VendorId value. More...
 
long entityId () const
 Extract the EntityId value. More...
 
long entityKey () const
 Extract the EntityKey value. More...
 
EntityKind entityKind () const
 Extract the EntityKind value. More...
 
bool isBuiltinDomainEntity () const
 Returns true if the GUID represents a builtin type domain entity. More...
 
bool isUserDomainEntity () const
 Returns true if the GUID represents a user defined type domain entity. More...
 
bool isWriter () const
 Returns true if the GUID represents a writer entity. More...
 
bool isReader () const
 Returns true if the GUID represents a reader entity. More...
 
bool isTopic () const
 Returns true if the GUID represents a topic entity. More...
 
 operator OPENDDS_STRING () const
 Convert to diagnostic string. More...
 
OPENDDS_STRING uniqueParticipantId () const
 

Additional Inherited Members

- Protected Attributes inherited from OpenDDS::DCPS::GuidConverter
const GUID_t guid_
 

Detailed Description

Conversion processing and value testing utilities for DCPS Information Repository identifiers.

This class encapsulates the conversion of a GUID_t value to and from other types used within OpenDDS.

Currently the RepoId is a typedef for GUID_t. This class assumes responsibility for insulating users from future change.

Currently the RepoId 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] == federation id (MS byte) 5 GUID_t.guidPrefix[ 5] == federation id 6 GUID_t.guidPrefix[ 6] == federation id 7 GUID_t.guidPrefix[ 7] == federation id (LS byte)

8 GUID_t.guidPrefix[ 8] == particpant id (MS byte) 9 GUID_t.guidPrefix[ 9] == particpant id 10 GUID_t.guidPrefix[10] == particpant id 11 GUID_t.guidPrefix[11] == particpant id (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

Definition at line 67 of file RepoIdConverter.h.

Constructor & Destructor Documentation

◆ RepoIdConverter()

OpenDDS::DCPS::RepoIdConverter::RepoIdConverter ( const GUID_t repoId)

Definition at line 17 of file RepoIdConverter.cpp.

18  : GuidConverter(repoId)
19 {}
GuidConverter(const GUID_t &guid)
Construct from a GUID_t.

◆ ~RepoIdConverter()

OpenDDS::DCPS::RepoIdConverter::~RepoIdConverter ( )

Definition at line 21 of file RepoIdConverter.cpp.

22 {}

Member Function Documentation

◆ federationId()

OpenDDS::Federator::RepoKey OpenDDS::DCPS::RepoIdConverter::federationId ( ) const

◆ participantId()

ParticipantId OpenDDS::DCPS::RepoIdConverter::participantId ( ) const

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