InstanceHandle_t Class Reference
[User Data Type Support]

Type definition for an instance handle. More...

Inheritance diagram for InstanceHandle_t:

List of all members.

Public Member Functions
	InstanceHandle_t ()
	InstanceHandle_t (InstanceHandle_t src)
boolean	is_nil ()
	Compare this handle to InstanceHandle_t.HANDLE_NIL.
Object	copy_from (Object src)
	Copy value of a data type from source.
boolean	equals (Object other)
	Compares this instance handle with another handle for equality.
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.dds.topic.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.

See also:

HANDLE_NIL

InstanceHandle_t

(

InstanceHandle_t

src

)

Construct a new instance handle equal to the given handle.

Exceptions:

NullPointerException

if src is null

---

Member Function Documentation

boolean is_nil

(

)

Compare this handle to InstanceHandle_t.HANDLE_NIL.

Returns:

true if the given instance handle is equal to InstanceHandle_t.HANDLE_NIL or false otherwise.

See also:

com.rti.dds.infrastructure.InstanceHandle_t.equals

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.

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:

true if the two handles have equal values, or false otherwise.

See also:

com.rti.dds.infrastructure.InstanceHandle_t.is_nil

---

Member Data Documentation

final InstanceHandle_t HANDLE_NIL [static]

The NIL instance handle.

Special com.rti.dds.infrastructure.InstanceHandle_t value

See also:

com.rti.dds.infrastructure.InstanceHandle_t.is_nil