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.HANDLE_NIL. More...

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

boolean	equals (Object other)
	Compares this instance handle with another handle for equality. More...

int	compare (InstanceHandle_t other)
	Compares this instance handle with another handle. More...

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

Static Public Attributes
static final InstanceHandle_t	HANDLE_NIL
	The NIL instance handle. More...

Detailed Description

Type definition for an instance handle.

Handle to identify 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() [1/2]

InstanceHandle_t ( )

Construct a new instance handle equal to the nil handle.

See also: HANDLE_NIL

Referenced by InstanceHandle_t.copy_from(), and InstanceHandle_t.equals().

◆ InstanceHandle_t() [2/2]

InstanceHandle_t ( InstanceHandle_t src )

Construct a new instance handle equal to the given handle.

Exceptions

NullPointerException if src is null

References InstanceHandle_t.copy_from().

Member Function Documentation

◆ is_nil()

boolean is_nil ( )

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

Returns: com.rti.dds.infrastructure.true if the given instance handle is equal to com.rti.dds.infrastructure.InstanceHandle_t.HANDLE_NIL or com.rti.dds.infrastructure.false otherwise.

See also: com.rti.dds.infrastructure.InstanceHandle_t.equals

◆ 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 InstanceHandle_t.InstanceHandle_t().

Referenced by SampleInfo.copy_from(), WriteParams_t.copy_from(), InstanceHandle_t.InstanceHandle_t(), and WriteParams_t.WriteParams_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

References InstanceHandle_t.equals(), and InstanceHandle_t.InstanceHandle_t().

Referenced by InstanceHandle_t.equals(), and WriteParams_t.WriteParams_t().

◆ compare()

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.