RTI Connext Java API  Version 5.3.1
 All Classes Namespaces Functions Variables Groups Pages
BuiltinTopicKey_t Class Reference

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

Inheritance diagram for BuiltinTopicKey_t:
Copyable

Public Member Functions

int[] to_int_array ()
 Returns an array of four integers that uniquely represents a remote com.rti.dds.infrastructure.Entity.
 
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.
 
boolean is_keyed_reader ()
 Returns true if this key identifies a keyed DataReader.
 
boolean is_keyed_writer ()
 Returns true if this key identifies a keyed DataWriter.
 
boolean is_unkeyed_reader ()
 Returns true if this key identifies an unkeyed DataReader.
 
boolean is_unkeyed_writer ()
 Returns true if this key identifies an unkeyed DataWriter.
 
boolean is_participant ()
 Returns true if this key identifies a DomainParticipant.
 
boolean is_user_entity ()
 Returns true if this key identifies an user Entity.
 
boolean is_builtin_entity ()
 Returns true if this key identifies a built-in Entity.
 
boolean is_vendor_entity ()
 Returns true if this key identifies a vendor Entity.
 
boolean is_vendor_builtin_entity ()
 Returns true if this key identifies a built-in vendor Entity.
 
int get_entity_kind ()
 Returns an integer identifying the entity kind for the key.
 
void to_guid (GUID_t dst)
 Converts this Key into a GUID.
 
void from_guid (GUID_t src)
 Initializes this Key from the input GUID.
 
- Public Member Functions inherited from Copyable
Object copy_from (Object src)
 Copy value of a data type from source.
 

Public Attributes

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

Static Public Attributes

static final int KEYED_READER_ENTITY_KIND = 0x07
 Constant representing a keyed DataReader.
 
static final int KEYED_WRITER_ENTITY_KIND = 0x02
 Constant representing a keyed DataWriter.
 
static final int UNKEYED_READER_ENTITY_KIND = 0x04
 Constant representing an unkeyed DataReader.
 
static final int UNKEYED_WRITER_ENTITY_KIND = 0x03
 Constant representing an unkeyed DataWriter.
 
static final int PARTICIPANT_ENTITY_KIND = 0x01
 Constant representing a DomainParticipant.
 

Additional Inherited Members

- Protected Attributes inherited from BuiltinKey_t
final int[] _value = { 0, 0, 0, 0 }
 

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

int [] to_int_array ( )

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

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.

boolean is_keyed_reader ( )

Returns true if this key identifies a keyed DataReader.

boolean is_keyed_writer ( )

Returns true if this key identifies a keyed DataWriter.

boolean is_unkeyed_reader ( )

Returns true if this key identifies an unkeyed DataReader.

boolean is_unkeyed_writer ( )

Returns true if this key identifies an unkeyed DataWriter.

boolean is_participant ( )

Returns true if this key identifies a DomainParticipant.

boolean is_user_entity ( )

Returns true if this key identifies an user Entity.

boolean is_builtin_entity ( )

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

boolean is_vendor_entity ( )

Returns true if this key identifies a vendor Entity.

boolean is_vendor_builtin_entity ( )

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

void to_guid ( GUID_t  dst)

Converts this Key into a GUID.

Parameters
dst<<out>> The destination 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.

Member Data Documentation

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.

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.

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.

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.

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.

final int [] value

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


RTI Connext Java API Version 5.3.1 Copyright © Mon Feb 19 2018 Real-Time Innovations, Inc