DoubleSeq Class Reference
[Built-in Sequences]

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

Inheritance diagram for DoubleSeq:

List of all members.

Public Member Functions
	DoubleSeq ()
	Constructs an empty sequence of doubles with an initial maximum of zero.
	DoubleSeq (int initialMaximum)
	Constructs an empty sequence of doubles with the given initial maximum.
	DoubleSeq (double[] doubles)
	Constructs a new sequence containing the given doubles.
final boolean	addAllDouble (double[] elements, int offset, int length)
	Append length elements from the given array to this sequence, starting at index offset in that array.
final boolean	addAllDouble (double[] elements)
final void	addDouble (double element)
	Append the element to the end of the sequence.
final void	addDouble (int index, double element)
	Shift all elements in the sequence starting from the given index and add the element to the given index.
final double	getDouble (int index)
	Returns the double at the given index.
final double	setDouble (int index, double element)
	Set the new double at the given index and return the old double.
final void	setDouble (int dstIndex, double[] elements, int srcIndex, int length)
	Copy a portion of the given array into this sequence.
final double[]	toArrayDouble (double[] array)
	Return an array containing copy of the contents of this sequence.
final int	getMaximum ()
	Get the current maximum number of elements that can be stored in this sequence.
final Object	get (int index)
	A wrapper for getDouble(int) that returns a java.lang.Double.
final Object	set (int index, Object element)
	A wrapper for setDouble().
final void	add (int index, Object element)
	A wrapper for addDouble(int, int).

---

Detailed Description

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

Instantiates:

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

See also:

double

com.rti.dds.util.Sequence

---

Constructor & Destructor Documentation

DoubleSeq

(

)

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

DoubleSeq

(

int

initialMaximum

)

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

DoubleSeq

(

double[]

doubles

)

Constructs a new sequence containing the given doubles.

Parameters:

doubles

the initial contents of this sequence

Exceptions:

NullPointerException

if the input array is null

---

Member Function Documentation

final boolean addAllDouble	(	double[]	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.

final boolean addAllDouble

(

double[]

elements

)

Exceptions:

NullPointerException

if the given array is null

final void addDouble

(

double

element

)

Append the element to the end of the sequence.

final void addDouble	(	int	index,
		double	element
	)

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

final double getDouble

(

int

index

)

Returns the double at the given index.

Exceptions:

IndexOutOfBoundsException

if the index is out of bounds.

final double setDouble	(	int	index,
		double	element
	)

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

Exceptions:

IndexOutOfBoundsException

if the index is out of bounds.

final void setDouble	(	int	dstIndex,
		double[]	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.

final double [] toArrayDouble

(

double[]

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.

final 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.

final Object get

(

int

index

)

[virtual]

A wrapper for getDouble(int) that returns a java.lang.Double.

See also:

java.util.List.get(int)

Implements AbstractPrimitiveSequence.

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

A wrapper for setDouble().

Exceptions:

ClassCastException

if the element is not of type Double.

See also:

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

Implements AbstractPrimitiveSequence.

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

A wrapper for addDouble(int, int).

Exceptions:

ClassCastException

if the element is not of type Double.

See also:

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

Implements AbstractPrimitiveSequence.