RTI Connext Java API Version 7.3.0
|
The key type of the built-in topic types. More...
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. The integer can take one of the following values: 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... | |
Object | copy_from (Object src) |
Copy value of a data type from source. 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... | |
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.
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.
src | <<in>> The Object which contains the data to be copied. |
NullPointerException | If src is null. |
ClassCastException | If src is not the same type as this. |
Implements Copyable.
int[] to_int_array | ( | ) |
Returns an array of four integers that uniquely represents a remote com.rti.dds.infrastructure.Entity.
References BuiltinTopicKey_t.value.
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.
References BuiltinTopicKey_t.value.
boolean is_keyed_reader | ( | ) |
Returns true if this key identifies a keyed DataReader.
References BuiltinTopicKey_t.KEYED_READER_ENTITY_KIND, and BuiltinTopicKey_t.value.
boolean is_keyed_writer | ( | ) |
Returns true if this key identifies a keyed DataWriter.
References BuiltinTopicKey_t.KEYED_WRITER_ENTITY_KIND, and BuiltinTopicKey_t.value.
boolean is_unkeyed_reader | ( | ) |
Returns true if this key identifies an unkeyed DataReader.
References BuiltinTopicKey_t.UNKEYED_READER_ENTITY_KIND, and BuiltinTopicKey_t.value.
boolean is_unkeyed_writer | ( | ) |
Returns true if this key identifies an unkeyed DataWriter.
References BuiltinTopicKey_t.UNKEYED_WRITER_ENTITY_KIND, and BuiltinTopicKey_t.value.
boolean is_participant | ( | ) |
Returns true if this key identifies a DomainParticipant.
References BuiltinTopicKey_t.value.
boolean is_user_entity | ( | ) |
Returns true if this key identifies an user Entity.
References BuiltinTopicKey_t.value.
boolean is_builtin_entity | ( | ) |
Returns true if this key identifies a built-in Entity.
References BuiltinTopicKey_t.value.
boolean is_vendor_entity | ( | ) |
Returns true if this key identifies a vendor Entity.
References BuiltinTopicKey_t.value.
boolean is_vendor_builtin_entity | ( | ) |
Returns true if this key identifies a built-in vendor Entity.
References BuiltinTopicKey_t.value.
int get_entity_kind | ( | ) |
Returns an integer identifying the entity kind for the key. The integer can take one of the following values:
References BuiltinTopicKey_t.value.
void to_guid | ( | GUID_t | dst | ) |
Converts this Key into a GUID.
dst | <<out>> The destination GUID. |
References GUID_t.value, and BuiltinTopicKey_t.value.
void from_guid | ( | GUID_t | src | ) |
Initializes this Key from the input GUID.
src | <<in>> The GUID to be used to initialize this Key. |
References GUID_t.value, and BuiltinTopicKey_t.value.
|
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.
Referenced by BuiltinTopicKey_t.is_keyed_reader().
|
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.
Referenced by BuiltinTopicKey_t.is_keyed_writer().
|
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.
Referenced by BuiltinTopicKey_t.is_unkeyed_reader().
|
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.
Referenced by BuiltinTopicKey_t.is_unkeyed_writer().
|
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.
Referenced by BuiltinTopicKey_t.from_guid(), BuiltinTopicKey_t.from_int_array(), BuiltinTopicKey_t.get_entity_kind(), BuiltinTopicKey_t.is_builtin_entity(), BuiltinTopicKey_t.is_keyed_reader(), BuiltinTopicKey_t.is_keyed_writer(), BuiltinTopicKey_t.is_participant(), BuiltinTopicKey_t.is_unkeyed_reader(), BuiltinTopicKey_t.is_unkeyed_writer(), BuiltinTopicKey_t.is_user_entity(), BuiltinTopicKey_t.is_vendor_builtin_entity(), BuiltinTopicKey_t.is_vendor_entity(), BuiltinTopicKey_t.to_guid(), and BuiltinTopicKey_t.to_int_array().