com.kuka.roboticsAPI.controllerModel.sunrise.connectionLib
Interface ISerializableType

All Superinterfaces:

Cloneable, com.kuka.common.IDataEquatable

All Known Implementing Classes:

ComplexSerializableType, SerializableArray, SerializableBLOB, SerializableBoolean, SerializableDouble, SerializableDouble2DArray, SerializableDoubleArray, SerializableGroup, SerializableInteger, SerializableIntegerArray, SerializableList, SerializablePortInfo, SerializableString, SerializableTransformationMatrix, SerializableType, SplineData

public interface ISerializableType
extends Cloneable, com.kuka.common.IDataEquatable

Interface for Sunrise serializable 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.

Method Summary

ISerializableType	clone() Creates a copy of this serializable type.
void	fromByteBuffer(FastByteBuffer buffer, int startIndex) Deserializes a type from a byte buffer.
void	fromString(String value) Deserializes the type from a String representation.
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.
String	getParameterName() Gets the name of this serializable type object if it is used as named message parameter.
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.
void	setParameterName(String name) Sets the name of this serializable type object if it is used as named message parameter.
void	setValue(Object value) Sets the value for this type.
int	toByteBuffer(FastByteBuffer buffer, int startIndex) Serializes the type in a byte buffer.

Methods inherited from interface com.kuka.common.IDataEquatable

hasSameDataAs

Method Detail

toByteBuffer

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.

fromByteBuffer

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.

getValue

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.

setValue

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.

getParameterType

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.

getParameterName

String getParameterName()

Gets the name of this serializable type object if it is used as named message parameter.

Returns:

the name of this serializable type object if it is used as named message parameter. null if no name was set.

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.

setParameterName

void setParameterName(String name)

Sets the name of this serializable type object if it is used as named message parameter.

Parameters:

name - parameter name to set.

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

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.

getLength

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.

getDimensions

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.

fromString

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.

clone

ISerializableType clone()
                        throws CloneNotSupportedException

Creates a copy of this serializable type.

Returns:

A copy of this serializable type.

Throws:

CloneNotSupportedException - Cloning not supported.

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.