The key type of the built-in topic types. More...

Inheritance diagram for BuiltinTopicKey_t:

Public Member Functions
Object	copy_from (Object src)
	Copy value of a data type from source. More...

int []	to_int_array ()
	Returns an array of four integers that uniquely represents a remote com.rti.dds.infrastructure.Entity. More...

void	from_int_array (int[] iValue)
	Initializes this key from an array of four integers that uniquely represents a remote com.rti.dds.infrastructure.Entity. More...

boolean	is_keyed_reader ()
	Returns true if this key identifies a keyed DataReader. More...

boolean	is_keyed_writer ()
	Returns true if this key identifies a keyed DataWriter. More...

boolean	is_unkeyed_reader ()
	Returns true if this key identifies an unkeyed DataReader. More...

boolean	is_unkeyed_writer ()
	Returns true if this key identifies an unkeyed DataWriter. More...

boolean	is_participant ()
	Returns true if this key identifies a DomainParticipant. More...

boolean	is_user_entity ()
	Returns true if this key identifies an user Entity. More...

boolean	is_builtin_entity ()
	Returns true if this key identifies a built-in Entity. More...

boolean	is_vendor_entity ()
	Returns true if this key identifies a vendor Entity. More...

boolean	is_vendor_builtin_entity ()
	Returns true if this key identifies a built-in vendor Entity. More...

int	get_entity_kind ()
	Returns an integer identifying the entity kind for the key. More...

void	to_guid (GUID_t dst)
	Converts this Key into a GUID. More...

void	from_guid (GUID_t src)
	Initializes this Key from the input GUID. More...

Public Attributes
final int []	value
	An array of four integers that uniquely represents a remote com.rti.dds.infrastructure.Entity. More...

Static Public Attributes
static final int	KEYED_READER_ENTITY_KIND = 0x07
	Constant representing a keyed DataReader. More...

static final int	KEYED_WRITER_ENTITY_KIND = 0x02
	Constant representing a keyed DataWriter. More...

static final int	UNKEYED_READER_ENTITY_KIND = 0x04
	Constant representing an unkeyed DataReader. More...

static final int	UNKEYED_WRITER_ENTITY_KIND = 0x03
	Constant representing an unkeyed DataWriter. More...

static final int	PARTICIPANT_ENTITY_KIND = 0x01
	Constant representing a DomainParticipant. More...

Detailed Description

The key type of the built-in topic types.

Each remote com.rti.dds.infrastructure.Entity to be discovered can be uniquely identified by this key. This is the key of all the built-in topic data types.

See also: com.rti.dds.domain.builtin.ParticipantBuiltinTopicData; builtin.TopicBuiltinTopicData; com.rti.dds.publication.builtin.PublicationBuiltinTopicData; com.rti.dds.subscription.builtin.SubscriptionBuiltinTopicData

Member Function Documentation

◆ copy_from()

Object copy_from ( Object src )

Copy value of a data type from source.

Copy data into this object from another. This copy is intended to be a deep copy, so that all data members (recursively) are copied (not just resetting Object references).

This operation returns the object that is copied if copy is successful.

Parameters

src	<<in>> The Object which contains the data to be copied.

Returns: Generally, return this but special cases (such as Enum) exist.

Exceptions

NullPointerException	If src is null.
ClassCastException	If src is not the same type as this.

Implements Copyable.

References BuiltinTopicKey_t.value.

◆ to_int_array()

int [] to_int_array ( )

Returns an array of four integers that uniquely represents a remote com.rti.dds.infrastructure.Entity.

◆ from_int_array()

void from_int_array ( int [] iValue )

Initializes this key from an array of four integers that uniquely represents a remote com.rti.dds.infrastructure.Entity.

◆ is_keyed_reader()

boolean is_keyed_reader ( )

Returns true if this key identifies a keyed DataReader.

◆ is_keyed_writer()

boolean is_keyed_writer ( )

Returns true if this key identifies a keyed DataWriter.

◆ is_unkeyed_reader()

boolean is_unkeyed_reader ( )

Returns true if this key identifies an unkeyed DataReader.

◆ is_unkeyed_writer()

boolean is_unkeyed_writer ( )

Returns true if this key identifies an unkeyed DataWriter.

◆ is_participant()

boolean is_participant ( )

Returns true if this key identifies a DomainParticipant.

◆ is_user_entity()

boolean is_user_entity ( )

Returns true if this key identifies an user Entity.

◆ is_builtin_entity()

boolean is_builtin_entity ( )

Returns true if this key identifies a built-in Entity.

◆ is_vendor_entity()

boolean is_vendor_entity ( )

Returns true if this key identifies a vendor Entity.

◆ is_vendor_builtin_entity()

boolean is_vendor_builtin_entity ( )

Returns true if this key identifies a built-in vendor Entity.

◆ get_entity_kind()

int get_entity_kind ( )

Returns an integer identifying the entity kind for the key.

The integer can take one of the following values:

◆ to_guid()

void to_guid ( GUID_t dst )

Converts this Key into a GUID.

Parameters

dst	<<out>> The destination GUID.

References GUID_t.value.

◆ from_guid()

void from_guid ( GUID_t src )

Initializes this Key from the input GUID.

Parameters

src	<<in>> The GUID to be used to initialize this Key.

References GUID_t.value.

Member Data Documentation

◆ KEYED_READER_ENTITY_KIND

final int KEYED_READER_ENTITY_KIND = 0x07

static

Constant representing a keyed DataReader.

The user can use this constant to inspect the returned value of the method builtin.BuiltinTopicKey_t.get_entity_kind.

◆ KEYED_WRITER_ENTITY_KIND

final int KEYED_WRITER_ENTITY_KIND = 0x02

static

Constant representing a keyed DataWriter.

The user can use this constant to inspect the returned value of the method builtin.BuiltinTopicKey_t.get_entity_kind.

◆ UNKEYED_READER_ENTITY_KIND

final int UNKEYED_READER_ENTITY_KIND = 0x04

static

Constant representing an unkeyed DataReader.

The user can use this constant to inspect the returned value of the method builtin.BuiltinTopicKey_t.get_entity_kind.

◆ UNKEYED_WRITER_ENTITY_KIND

final int UNKEYED_WRITER_ENTITY_KIND = 0x03

static

Constant representing an unkeyed DataWriter.

The user can use this constant to inspect the returned value of the method builtin.BuiltinTopicKey_t.get_entity_kind.

◆ PARTICIPANT_ENTITY_KIND

final int PARTICIPANT_ENTITY_KIND = 0x01

static

Constant representing a DomainParticipant.

The user can use this constant to inspect the returned value of the method builtin.BuiltinTopicKey_t.get_entity_kind.

◆ value

final int [] value

An array of four integers that uniquely represents a remote com.rti.dds.infrastructure.Entity.

Referenced by BuiltinTopicKey_t.copy_from().

Public Member Functions

Public Attributes

Static Public Attributes

Detailed Description

Member Function Documentation

◆ copy_from()

◆ to_int_array()

◆ from_int_array()

◆ is_keyed_reader()

◆ is_keyed_writer()

◆ is_unkeyed_reader()

◆ is_unkeyed_writer()

◆ is_participant()

◆ is_user_entity()

◆ is_builtin_entity()

◆ is_vendor_entity()

◆ is_vendor_builtin_entity()

◆ get_entity_kind()

◆ to_guid()

◆ from_guid()

Member Data Documentation

◆ KEYED_READER_ENTITY_KIND

◆ KEYED_WRITER_ENTITY_KIND

◆ UNKEYED_READER_ENTITY_KIND

◆ UNKEYED_WRITER_ENTITY_KIND

◆ PARTICIPANT_ENTITY_KIND

◆ value