com.kuka.parameters.user
Interface IUserParameter<T>

Type Parameters:

T - The concrete type of the class that implements this IUserParameter, the type of the parameter's value.

All Known Implementing Classes:

UserParameter

public interface IUserParameter<T>

Interface that represents the user parameters for a geometric object that may be part of the scene graph.

All methods of this interface are thread-safe.

Method Summary

String	getDisplayName() Returns the display name corresponding to this user parameter.
String	getKey() Returns the key corresponding to this user parameter.
T	getValue() Returns the value corresponding to this user parameter.
Class<T>	getValueType() Returns a Class object that identifies the declared type for the value corresponding to this user parameter - the type of generic type parameter T.
void	setDisplayName(String displayName) Sets the display name corresponding to this user parameter.
void	setValue(T value) Sets the value corresponding to this user parameter.

Method Detail

getKey

String getKey()

Returns the key corresponding to this user parameter.

Returns:

The key corresponding to this user parameter.

getValue

T getValue()

Returns the value corresponding to this user parameter.

Returns:

The value corresponding to this user parameter.

getDisplayName

String getDisplayName()

Returns the display name corresponding to this user parameter.

Returns:

The display name corresponding to this user parameter.

getValueType

Class<T> getValueType()

Returns a Class object that identifies the declared type for the value corresponding to this user parameter - the type of generic type parameter T.

Returns:

A Class object that identifies the declared type for the value corresponding to this user parameter.

setDisplayName

void setDisplayName(String displayName)

Sets the display name corresponding to this user parameter.

Parameters:

displayName - The display name property of this user parameter, allowed object is String.

setValue

void setValue(T value)

Sets the value corresponding to this user parameter.

Parameters:

value - The value corresponding to this user parameter. The type of the value is restricted to the generic template parameter.