FooSeq Struct Reference

<<interface>> <<generic>> <<cert>> A type-safe, ordered collection of elements. The type of these elements is referred to in this documentation as "Foo". More...

#include <dds_c_sequence.h>

Data Fields
Foo *	_contiguous_buffer
	Pointer to array of contiguous or discontiguous data.
DDS_UnsignedLong	_maximum
	Maximum size of the sequence.
DDS_UnsignedLong	_length
	Actual length of the sequence that contains data.
DDS_Long	_element_size
	Size of data element in the sequence.
void *	_token1
	Reserved for internal use.
void *	_token2
	Reserved for internal use.
DDS_UnsignedLong	max_alloc_size
	The maximum allocation for pointer elements (string,wstring) Only in debug librarires.
DDS_Char	_flags
	Reserved for internal use.

---

Detailed Description

<<interface>> <<generic>> <<cert>> A type-safe, ordered collection of elements. The type of these elements is referred to in this documentation as "Foo".

We refer to an IDL sequence<Foo> as FooSeq.

The state of a sequence is described by the properties 'maximum', and 'length'.

• The 'maximum' represents the size of the underlying buffer; this is the maximum number of elements it can possibly hold. It is returned by the FooSeq_get_maximum operation.

• The 'length' represents the actual number of elements it currently holds. It is returned by the FooSeq_get_length operation.

---

Field Documentation

Foo* FooSeq::_contiguous_buffer

Pointer to array of contiguous or discontiguous data.

DDS_UnsignedLong FooSeq::_maximum

Maximum size of the sequence.

The allocated length of this sequence. It applies to whichever of the above buffers is non-NULL, if any. If both a NULL, its value must be 0.

If _maximum == 0, _owned == true.

DDS_UnsignedLong FooSeq::_length

Actual length of the sequence that contains data.

The current logical length of this seqeunce, i.e. the number of valid elements it contains. It applies to whichever of the above buffers is non-null, if any. If both are NULL, its value must be 0.

DDS_Long FooSeq::_element_size

Size of data element in the sequence.

Each element in the sequence has this size.

void* FooSeq::_token1

Reserved for internal use.

void* FooSeq::_token2

Reserved for internal use.

DDS_UnsignedLong FooSeq::max_alloc_size

The maximum allocation for pointer elements (string,wstring) Only in debug librarires.

DDS_Char FooSeq::_flags

Reserved for internal use.