FloatSeq Class Reference
[Built-in Sequences]

Instantiates com.rti.dds.util.Sequence < float >. More...

Inheritance diagram for FloatSeq:

List of all members.

Public Member Functions
	FloatSeq ()
	Constructs an empty sequence of floats with an initial maximum of zero.
	FloatSeq (int initialMaximum)
	Constructs an empty sequence of floats with the given initial maximum.
	FloatSeq (float[] floats)
	Constructs a new sequence containing the given floats.
boolean	addAllFloat (float[] elements, int offset, int length)
	Append length elements from the given array to this sequence, starting at index offset in that array.
boolean	addAllFloat (float[] elements)
void	addFloat (float element)
	Append the element to the end of the sequence.
void	addFloat (int index, float element)
	Shift all elements in the sequence starting from the given index and add the element to the given index.
float	getFloat (int index)
	Returns the float at the given index.
float	setFloat (int index, float element)
	Set the new float at the given index and return the old float.
void	setFloat (int dstIndex, float[] elements, int srcIndex, int length)
	Copy a portion of the given array into this sequence.
float[]	toArrayFloat (float[] array)
	Return an array containing copy of the contents of this sequence.
int	getMaximum ()
	Get the current maximum number of elements that can be stored in this sequence.
Object	get (int index)
	A wrapper for getFloat(int) that returns a java.lang.Float.
Object	set (int index, Object element)
	A wrapper for setFloat().
void	add (int index, Object element)
	A wrapper for addFloat(int, int).

---

Detailed Description

Instantiates com.rti.dds.util.Sequence < float >.

Instantiates:

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

See also:

float

com.rti.dds.util.Sequence

---

Constructor & Destructor Documentation

FloatSeq

(

)

Constructs an empty sequence of floats with an initial maximum of zero.

FloatSeq

(

int

initialMaximum

)

Constructs an empty sequence of floats with the given initial maximum.

FloatSeq

(

float[]

floats

)

Constructs a new sequence containing the given floats.

Parameters:

floats

the initial contents of this sequence

Exceptions:

NullPointerException

if the input array is null

---

Member Function Documentation

boolean addAllFloat	(	float[]	elements,
		int	offset,
		int	length
	)

Append length elements from the given array to this sequence, starting at index offset in that array.

Exceptions:

NullPointerException

if the given array is null.

boolean addAllFloat

(

float[]

elements

)

Exceptions:

NullPointerException

if the given array is null

void addFloat

(

float

element

)

Append the element to the end of the sequence.

void addFloat	(	int	index,
		float	element
	)

Shift all elements in the sequence starting from the given index and add the element to the given index.

float getFloat

(

int

index

)

Returns the float at the given index.

Exceptions:

IndexOutOfBoundsException

if the index is out of bounds.

float setFloat	(	int	index,
		float	element
	)

Set the new float at the given index and return the old float.

Exceptions:

IndexOutOfBoundsException

if the index is out of bounds.

void setFloat	(	int	dstIndex,
		float[]	elements,
		int	srcIndex,
		int	length
	)

Copy a portion of the given array into this sequence.

Parameters:

	dstIndex	the index at which to start copying into this sequence.
	elements	an array of primitive elements.
	srcIndex	the index at which to start copying from the given array.
	length	the number of elements to copy.

Exceptions:

IndexOutOfBoundsException

if copying would cause access of data outside array bounds.

float [] toArrayFloat

(

float[]

array

)

Return an array containing copy of the contents of this sequence.

Parameters:

array

The array into which this sequence should be copied. It may be null. If it is, or if array length is too small, the array will be ignored, and a new array of the necessary length will be created and copied into instead.

Returns:

A non-null array containing a copy of the contents of this sequence.

int getMaximum

(

)

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.

The maximum is a non-negative number. It is initialized when the sequence is first created.

The maximum can be changed implicitly by adding an element to the sequence with add(), or explicitly by calling Sequence.setMaximum.

Returns:

the current maximum of the sequence.

See also:

Sequence.size()

Implements Sequence.

Object get

(

int

index

)

[virtual]

A wrapper for getFloat(int) that returns a java.lang.Float.

See also:

java.util.List.get(int)

Implements AbstractPrimitiveSequence.

Object set	(	int	index,
		Object	element
	)			[virtual]

A wrapper for setFloat().

Exceptions:

ClassCastException

if the element is not of type Float.

See also:

java.util.List.set(int, java.lang.Object)

Implements AbstractPrimitiveSequence.

void add	(	int	index,
		Object	element
	)			[virtual]

A wrapper for addFloat(int, int).

Exceptions:

ClassCastException

if the element is not of type Float.

See also:

java.util.List.add(int, java.lang.Object)

Implements AbstractPrimitiveSequence.