InstanceHandleSeq Class Reference
[User Data Type Support]

Instantiates com.rti.dds.util.Sequence < com.rti.dds.infrastructure.InstanceHandle_t > . More...

Inherits ArraySequence.

List of all members.

Public Member Functions
	InstanceHandleSeq ()
	Construct a new empty sequence for com.rti.dds.infrastructure.InstanceHandle_t elements.
	InstanceHandleSeq (int initial_maximum)
	Construct a new empty sequence for com.rti.dds.infrastructure.InstanceHandle_t elements.
	InstanceHandleSeq (Collection elements)
	Construct a new sequence containing the given com.rti.dds.infrastructure.InstanceHandle_t elements.
void	fill (int size)
	Fill this sequence with the given number of instance handles.

---

Detailed Description

Instantiates com.rti.dds.util.Sequence < com.rti.dds.infrastructure.InstanceHandle_t > .

When reading into this sequence (as with com.rti.dds.publication.DataWriter.get_matched_subscriptions or com.rti.dds.subscription.DataReader.get_matched_publications), the contents of any existing handles in this sequence will be overwritten to avoid the expense of allocating new handles. Therefore, it is generally not a good idea to add handles to a sequence that you obtained elsewhere (e.g. from a Status object or as a result of calling com.rti.dds.topic.example.FooDataWriter.register_instance). Any null elements will be replaced by new handles. To avoid allocating new handles on the fly, use the method com.rti.dds.infrastructure.InstanceHandleSeq.fill.

Instantiates:

<<generic>> com.rti.dds.util.Sequence

See also:

com.rti.dds.infrastructure.InstanceHandle_t

com.rti.dds.util.Sequence

---

Constructor & Destructor Documentation

InstanceHandleSeq

(

)

Construct a new empty sequence for com.rti.dds.infrastructure.InstanceHandle_t elements.

The maximum of the sequence will be set to a default value.

InstanceHandleSeq

(

int

initial_maximum

)

Construct a new empty sequence for com.rti.dds.infrastructure.InstanceHandle_t elements.

The maximum of the sequence will be set to the given value.

Parameters:

initial_maximum

<<in>> Maximum length of sequence.

InstanceHandleSeq

(

Collection

elements

)

Construct a new sequence containing the given com.rti.dds.infrastructure.InstanceHandle_t elements.

The maximum of the sequence will be set to the size of the given collection.

Parameters:

elements

<<in>> Elements to construct a sequence with.

---

Member Function Documentation

void fill

(

int

size

)

Fill this sequence with the given number of instance handles.

Ensure that this sequence has at least the given size and that all elements up to that count are non-null.

Parameters:

size

<<in>> Size of sequence to ensure.

Exceptions:

RETCODE_BAD_PARAMETER

If size < 0