dds_c_sequence.h File Reference

DDS sequence definitions. More...

#include "dds_c/dds_c_dll.h"
#include "dds_c/dds_c_common.h"
#include "reda/reda_sequence.h"

Go to the source code of this file.

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

Macros
#define	DDS_SEQUENCE_INITIALIZER(_t)
	An initializer for new sequence instances.

Functions
DDS_Boolean	FooSeq_initialize (struct FooSeq *self)
	Initialize sequence instances.
DDS_Boolean	FooSeq_finalize (struct FooSeq *self)
	Finalize sequence instances.
DDS_Long	FooSeq_get_maximum (const struct FooSeq *self)
	Get the current maximum number of elements that can be stored in this sequence. The maximum of the sequence represents the maximum number of elements that the underlying buffer can hold. It does not represent the current number of elements.
DDS_Boolean	FooSeq_set_maximum (struct FooSeq *self, DDS_Long new_max)
	Resize this sequence to a new desired maximum.
DDS_Long	FooSeq_get_length (const struct FooSeq *self)
	Get the logical length of this sequence. Get the length that was last set, or zero if the length has never been set.
DDS_Boolean	FooSeq_set_length (struct FooSeq *self, DDS_Long new_length)
	Change the length of this sequence.
Foo *	FooSeq_get_reference (const struct FooSeq *self, DDS_Long i)
	Get the pointer to the i-th element of this sequence.
struct FooSeq *	FooSeq_copy (struct FooSeq *self, const struct FooSeq *src_seq)
	Copy elements from another sequence, resizing the sequence if necessary.This method invokes copies the content of the specified sequence, after ensuring that this sequence has enough capacity to hold the elements to be copied.
DDS_Boolean	FooSeq_is_equal (struct FooSeq *self, struct FooSeq *other)
	Checks whether two sequences have the same contents.
DDS_Boolean	FooSeq_loan_contiguous (struct FooSeq *self, void *buffer, DDS_Long new_length, DDS_Long new_max)
	Loan a contiguous buffer to this sequence.
DDS_Boolean	FooSeq_loan_discontiguous (struct FooSeq *self, void *buffer, DDS_Long new_length, DDS_Long new_max)
	Loan a discontiguous buffer to this sequence.
DDS_Boolean	FooSeq_unloan (struct FooSeq *self)
	Return the loaned buffer in the sequence and set the maximum to 0.This method affects only the state of this sequence; it does not change the contents of the buffer in any way.
DDS_Boolean	FooSeq_has_ownership (const struct FooSeq *self)
	Return the value of the owned flag.
Foo *	FooSeq_get_buffer (struct FooSeq *self)
	Access the internal buffer of a sequence.
DDS_Boolean	FooSeq_set_buffer (struct FooSeq *self, Foo *buffer)
	Set the internal buffer of a sequence.
DDS_Boolean	FooSeq_has_discontiguous_buffer (const struct FooSeq *self)
	Check whether a sequence uses a contiguous or discontiguous buffer for its elements.

---

Detailed Description

DDS sequence definitions.