RTI Connext Java API  Version 6.0.0
 All Classes Namespaces Functions Variables Groups Pages
InstanceHandle_t Class Reference

Type definition for an instance handle. More...

Inheritance diagram for InstanceHandle_t:
Copyable

Public Member Functions

 InstanceHandle_t ()
 
 InstanceHandle_t (InstanceHandle_t src)
 
boolean is_nil ()
 Compare this handle to com.rti.dds.infrastructure.InstanceHandle_t.InstanceHandle_t.HANDLE_NIL.
 
boolean equals (Object other)
 Compares this instance handle with another handle for equality.
 
int compare (InstanceHandle_t other)
 Compares this instance handle with another handle.
 
- Public Member Functions inherited from Copyable
Object copy_from (Object src)
 Copy value of a data type from source.
 

Static Public Attributes

static final InstanceHandle_t HANDLE_NIL
 The NIL instance handle.
 

Detailed Description

Type definition for an instance handle.

Handle to identiy different instances of the same com.rti.dds.topic.Topic of a certain type.

See Also
com.rti.ndds.example.FooDataWriter.register_instance
com.rti.dds.subscription.SampleInfo.instance_handle

Constructor & Destructor Documentation

Construct a new instance handle equal to the nil handle.

See Also
HANDLE_NIL

Construct a new instance handle equal to the given handle.

Exceptions
NullPointerExceptionif src is null

Member Function Documentation

boolean is_nil ( )

Compare this handle to com.rti.dds.infrastructure.InstanceHandle_t.InstanceHandle_t.HANDLE_NIL.

Returns
com.rti.dds.infrastructure.true if the given instance handle is equal to com.rti.dds.infrastructure.InstanceHandle_t.InstanceHandle_t.HANDLE_NIL or com.rti.dds.infrastructure.false otherwise.
See Also
com.rti.dds.infrastructure.InstanceHandle_t.equals
boolean equals ( Object  other)

Compares this instance handle with another handle for equality.

Parameters
other<<in>> The other handle to be compared with this handle. Cannot be null.
Returns
com.rti.dds.infrastructure.true if the two handles have equal values, or com.rti.dds.infrastructure.false otherwise.
See Also
com.rti.dds.infrastructure.InstanceHandle_t.is_nil
int compare ( InstanceHandle_t  other)

Compares this instance handle with another handle.

Parameters
other<<in>> The other handle to be compared with this handle. Cannot be null.
Returns
If the two handles are equal, the function returns 0. If self is greater than other the function returns a positive number; otherwise, it returns a negative number.
See Also
com.rti.dds.infrastructure.InstanceHandle_t.is_nil

Member Data Documentation

final InstanceHandle_t HANDLE_NIL
static

RTI Connext Java API Version 6.0.0 Copyright © Sun Mar 3 2019 Real-Time Innovations, Inc