com.kuka.roboticsAPI.controllerModel.mapping
Class MappingToken<T extends ICommandContainer>

java.lang.Object
  com.kuka.roboticsAPI.controllerModel.mapping.MappingToken<T>

Type Parameters:

T - type of the command container for this token

All Implemented Interfaces:

com.kuka.common.ITaggable

Direct Known Subclasses:

SunriseMappingToken

public abstract class MappingToken<T extends ICommandContainer>
extends Object
implements com.kuka.common.ITaggable

A token that can be used during a mapping process of a command.

Subclasses may extends this token to provide additional methods during the mapping process.

The specialty of a token is it's data map which can store and retrieve arbitrary data. Through this mechanism, mappers can exchange data.

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

protected

MappingToken(T container) Creates a new mapping token.

Method Summary

T	getContainer() Gets the container for which this token was created.
com.kuka.common.params.IParameterSet	getDefaultParams() Returns the default parameters that should fill up unset parameters of every mapped command.
Object	getObjectToMap() Gets the object which should be mapped next.
Object	getOriginalCommand() Returns the original command from which the mapping process started.
Object	getTag(String key)
void	setObjectToMap(Object obj) Sets the next object which should be mapped.
void	setTag(String key, Object tag)

Methods inherited from class java.lang.Object

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

Constructor Detail

MappingToken

protected MappingToken(T container)

Creates a new mapping token.

Parameters:

container - The container for which this token is created.

Method Detail

getTag

public Object getTag(String key)

Specified by:

getTag in interface com.kuka.common.ITaggable

Parameters:

key - The key. null is not allowed.

Returns:

The data stored under the given key or null if not found.

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.

setTag

public void setTag(String key,
                   Object tag)

Specified by:

setTag in interface com.kuka.common.ITaggable

Parameters:

key - The key. null is not allowed.

tag - The value. null is not allowed.

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.

getContainer

public T getContainer()

Gets the container for which this token was created.

Returns:

The container.

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.

getObjectToMap

public Object getObjectToMap()

Gets the object which should be mapped next.

Returns:

The object which should be mapped next.

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.

setObjectToMap

public final void setObjectToMap(Object obj)

Sets the next object which should be mapped. Can be used to recursively traverse a command object.

Parameters:

obj - The object which should be mapped.

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.

getOriginalCommand

public Object getOriginalCommand()

Returns the original command from which the mapping process started.

Returns:

The original command from which the mapping process started.

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.

getDefaultParams

public com.kuka.common.params.IParameterSet getDefaultParams()

Returns the default parameters that should fill up unset parameters of every mapped command. May be null.

Returns:

the default parameter 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.