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

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

All Implemented Interfaces:

com.kuka.common.IDataEquatable, ISerializableType, Cloneable, Iterable<ISerializableType>

public final class SerializableGroup
extends SerializableType
implements Iterable<ISerializableType>

A group is a collection of data flow elements.

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

SerializableGroup()

Method Summary

void	addElement(String elementName, ISerializableType element) Adds a new element to this group.
SerializableGroup	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.
ISerializableType	getElement(int index) Gets the element at the specified index in the group.
ISerializableType	getElement(String elementName) Retrieves the element with the given name.
String	getElementName(int index) Gets the element name at the specified index in the group.
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)
Iterator<ISerializableType>	iterator()
void	setValue(Object value) Sets the value for this type.
int	size() Gets the amount of group elements of this group.
int	toByteBuffer(FastByteBuffer buffer, int startIndex) 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

SerializableGroup

public SerializableGroup()

Method Detail

fromString

public void fromString(String value)

Deserializes the type from a String representation.

Specified by:

fromString in interface ISerializableType

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.

getLength

public int getLength()

Gets the length in bytes of this type.

Specified by:

getLength in interface ISerializableType

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.

Specified by:

getParameterType in interface ISerializableType

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.

Specified by:

getTypeIdentifier in interface ISerializableType

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.

getDimensions

public int[] getDimensions()

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

Specified by:

getDimensions in interface ISerializableType

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.

fromByteBuffer

public void fromByteBuffer(FastByteBuffer buffer,
                           int startIndex)

Deserializes a type from a byte buffer.

Specified by:

fromByteBuffer in interface ISerializableType

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.

Specified by:

toByteBuffer in interface ISerializableType

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.

getValue

public Object getValue()

Gets the raw value of the serializable type.

Specified by:

getValue in interface ISerializableType

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

public void setValue(Object value)

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

Specified by:

setValue in interface ISerializableType

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.

clone

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

getElement

public ISerializableType getElement(String elementName)

Retrieves the element with the given name.

Parameters:

elementName - The name of the element.

Returns:

The element with the given name.

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.

addElement

public void addElement(String elementName,
                       ISerializableType element)

Adds a new element to this group.

Parameters:

elementName - The name of the element.

element - The element itself.

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.

iterator

public Iterator<ISerializableType> iterator()

Specified by:

iterator in interface Iterable<ISerializableType>

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 int size()

Gets the amount of group elements of this group.

Returns:

The amount of group elements of this group.

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.

getElement

public ISerializableType getElement(int index)

Gets the element at the specified index in the group.

Parameters:

index - The index.

Returns:

The element at the specified index in the group.

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.

getElementName

public String getElementName(int index)

Gets the element name at the specified index in the group.

Parameters:

index - The index.

Returns:

The element name at the specified index in the group.

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)

Specified by:

hasSameDataAs in interface com.kuka.common.IDataEquatable

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.