Type definition for an instance handle. More...

Inheritance diagram for InstanceHandle_t:

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.

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

InstanceHandle_t ( )

Construct a new instance handle equal to the nil handle.

InstanceHandle_t ( InstanceHandle_t src )

Construct a new instance handle equal to the given handle.

Exceptions

NullPointerException if src is null

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.

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.

final InstanceHandle_t HANDLE_NIL

static

The NIL instance handle.