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

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

All Implemented Interfaces:

com.kuka.common.IDataEquatable, ISerializableType, Cloneable

public final class ComplexSerializableType
extends SerializableType

General complex type. Can be used to just hold some values from return types.

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

ComplexSerializableType(TypeIdentifier identifier, int dim1, int dim2, int dim3, int dim4)
Creates a new complex type.

Method Summary

ISerializableType	clone() Creates a copy of this serializable type.
void	fromByteBuffer(FastByteBuffer buffer, int startIndexIn) Deserializes a type from a byte buffer.
void	fromString(String value) Deserializes this type out of a string.
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.
MessageParameterType	getParameterType() Gets the message type identifier of the type.
TypeIdentifier	getTypeIdentifier() Gets the Sunrise type identifier of the type.
Object	getValue() Gets the raw value of the serializable type.
boolean	hasSameDataAs(Object obj)
void	setValue(Object value) Sets the value for this type.
int	toByteBuffer(FastByteBuffer buffer, int startIndexIn) Serializes the type in a byte buffer.

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

getParameterName, hasParameterNameSet, setParameterName

Methods inherited from class java.lang.Object

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

Constructor Detail

ComplexSerializableType

public ComplexSerializableType(TypeIdentifier identifier,
                               int dim1,
                               int dim2,
                               int dim3,
                               int dim4)

Creates a new complex type.

Parameters:

identifier - The inner type of the complex type.

dim1 - Number of dimensions in 1. direction.

dim2 - Number of dimensions in 2. direction.

dim3 - Number of dimensions in 3. direction.

dim4 - Number of dimensions in 4. direction.

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.

Method Detail

setValue

public void setValue(Object value)

Sets the value for this type. Must be compatible with the type.

Parameters:

value - The value for this type. Must be compatible with the type. The value should never be null. Each subclass must check this.

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 this type out of a string.

Parameters:

value - The string 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.

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.

getParameterType

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

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.

getValue

public Object getValue()

Gets the raw value of the serializable type.

Returns:

The raw value of the serializable 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 startIndexIn)

Deserializes a type from a byte buffer.

Parameters:

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

startIndexIn - 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 startIndexIn)

Serializes the type in a byte buffer.

Parameters:

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

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

clone

public ISerializableType clone()

Creates a copy of this serializable type.

Specified by:

clone in interface ISerializableType

Specified by:

clone in class SerializableType

Returns:

A copy of this serializable 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.

hasSameDataAs

public boolean hasSameDataAs(Object obj)

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.