com.kuka.roboticsAPI.controllerModel.sunrise.api
Class Parameter<T>

java.lang.Object
  com.kuka.roboticsAPI.controllerModel.sunrise.api.Parameter<T>

Type Parameters:

T - The data type of the parameter.

All Implemented Interfaces:

com.kuka.common.IDataEquatable

public final class Parameter<T>
extends Object
implements com.kuka.common.IDataEquatable

A parameter is a simple key-value pair used to parameterize SPR components.

The value may be any Java data type, but it must be compatible with the Sunrise type system. This means, that is must be possible to convert the given type into an ISerializableType. The ParameterSerializer-class offers a convert(...) method, where you can test if you object is compatible. If not, you can inherit your type from ISerializableType and then it will work.

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

Parameter(String name, T value)
Creates a new parameter.

Method Summary

String	getName() Gets the name of the parameter.
T	getValue() Gets the value of this parameter.
boolean	hasSameDataAs(Object obj)
void	setValue(T value) Sets the value for this parameter.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Parameter

public Parameter(String name,
                 T value)

Creates a new parameter.

Parameters:

name - The name of the parameter.

value - The value of the parameter.

Method Detail

getName

public String getName()

Gets the name of the parameter.

Returns:

The name of the parameter.

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(T value)

Sets the value for this parameter.

Parameters:

value - The value for this parameter.

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 T getValue()

Gets the value of this parameter.

Returns:

The value of this parameter.

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.

toString

public String toString()

Overrides:

toString in class Object

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.