com.kuka.roboticsAPI.controllerModel.sunrise.connectionLib
Class SerializableArray

java.lang.Object
  com.kuka.roboticsAPI.controllerModel.sunrise.connectionLib.SerializableType
      com.kuka.roboticsAPI.controllerModel.sunrise.connectionLib.SerializableArray

All Implemented Interfaces:

com.kuka.common.IDataEquatable, ISerializableType, Cloneable

Direct Known Subclasses:

SerializableDouble2DArray, SerializableDoubleArray, SerializableIntegerArray

public abstract class SerializableArray
extends SerializableType

Base class for arrays.

This element is an undocumented internal feature. It is not intended to be used by applications as it might change or be removed in future versions.

Constructor Summary

protected

SerializableArray(ISerializableType helperWrapper) Creates a new serializable array.

Method Summary

void	fromByteBuffer(FastByteBuffer buffer, int startIndex) Deserializes a type from a byte buffer.
void	fromString(String value) Deserializes the type from a String representation.
abstract Object	get(int index) Gets the element at the specified index.
int[]	getDimensions() Gets the 4-dimensional integer array describing the order of this type in each of the four possible dimensions.
int	getLength() Gets the length in bytes of this type.
abstract MessageParameterType	getParameterType() Gets the message type identifier of the type.
TypeIdentifier	getTypeIdentifier() Gets the Sunrise type identifier of the type.
abstract void	set(int index, Object value) Sets the value at the specified index.
abstract int	size() Gets the size of the array.
protected static String[]	split(String valueIn) Helper method to split a value into it's array components.
int	toByteBuffer(FastByteBuffer buffer, int startIndex) Serializes the type in a byte buffer.

Methods inherited from class com.kuka.roboticsAPI.controllerModel.sunrise.connectionLib.SerializableType

clone, getParameterName, hasParameterNameSet, setParameterName

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.kuka.roboticsAPI.controllerModel.sunrise.connectionLib.ISerializableType

getValue, setValue

Methods inherited from interface com.kuka.common.IDataEquatable

hasSameDataAs

Constructor Detail

SerializableArray

protected SerializableArray(ISerializableType helperWrapper)

Creates a new serializable array.

Parameters:

helperWrapper - The helper object for the inner types of the array to serialize and deserialize them.

Method Detail

getDimensions

public int[] getDimensions()

Gets the 4-dimensional integer array describing the order of this type in each of the four possible dimensions.

Returns:

The 4-dimensional integer array describing the order of this type in each of the four possible dimensions.

This element is an undocumented internal feature. It is not intended to be used by applications as it might change or be removed in future versions.

getLength

public int getLength()

Gets the length in bytes of this type.

Returns:

The length in bytes of this type.

This element is an undocumented internal feature. It is not intended to be used by applications as it might change or be removed in future versions.

getTypeIdentifier

public TypeIdentifier getTypeIdentifier()

Gets the Sunrise type identifier of the type.

Returns:

The Sunrise type identifier of the type.

This element is an undocumented internal feature. It is not intended to be used by applications as it might change or be removed in future versions.

fromString

public void fromString(String value)

Deserializes the type from a String representation.

Parameters:

value - The string representation for the type.

This element is an undocumented internal feature. It is not intended to be used by applications as it might change or be removed in future versions.

fromByteBuffer

public void fromByteBuffer(FastByteBuffer buffer,
                           int startIndex)

Deserializes a type from a byte buffer.

Parameters:

buffer - The byte buffe from which the value should be deserialized.

startIndex - The start index of the deserialization.

This element is an undocumented internal feature. It is not intended to be used by applications as it might change or be removed in future versions.

toByteBuffer

public int toByteBuffer(FastByteBuffer buffer,
                        int startIndex)

Serializes the type in a byte buffer.

Parameters:

buffer - The byte buffer to which the value should be serialized.

startIndex - The start index for the serialization.

Returns:

The length in bytes of the serialized type.

This element is an undocumented internal feature. It is not intended to be used by applications as it might change or be removed in future versions.

getParameterType

public abstract MessageParameterType getParameterType()

Gets the message type identifier of the type.

Returns:

The message type identifier of the type.

This element is an undocumented internal feature. It is not intended to be used by applications as it might change or be removed in future versions.

set

public abstract void set(int index,
                         Object value)

Sets the value at the specified index.

Parameters:

index - The index.

value - The value.

This element is an undocumented internal feature. It is not intended to be used by applications as it might change or be removed in future versions.

size

public abstract int size()

Gets the size of the array.

Returns:

The size of the array.

This element is an undocumented internal feature. It is not intended to be used by applications as it might change or be removed in future versions.

get

public abstract Object get(int index)

Gets the element at the specified index.

Parameters:

index - The index.

Returns:

The element at the specified index.

This element is an undocumented internal feature. It is not intended to be used by applications as it might change or be removed in future versions.

split

protected static String[] split(String valueIn)

Helper method to split a value into it's array components. Delimiters are ; , and white spaces.

Parameters:

valueIn - The string value. null is not allowed.

Returns:

The string components.