com.kuka.roboticsAPI.controllerModel.sunrise.mapping
Class AbstractMotionOverlayMapper

java.lang.Object
  com.kuka.roboticsAPI.controllerModel.mapping.AbstractMapper<SunriseMappingToken>
      com.kuka.roboticsAPI.controllerModel.sunrise.mapping.SunriseMapper
          com.kuka.roboticsAPI.controllerModel.sunrise.mapping.AbstractMotionOverlayMapper

public abstract class AbstractMotionOverlayMapper
extends SunriseMapper

Abstract Base class for motion overlay mappers.

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

AbstractMotionOverlayMapper()

Method Summary

abstract Collection<Class<?>>	getMappingTypes() Gets the mapping types which this mapper can map.
void	map(SunriseMappingToken info) This method is called when the mapper should map a command for which it is registered.
protected abstract void	mapMotionOverlay(SunriseMappingToken info, int instance) Maps a motion overlay.

Methods inherited from class com.kuka.roboticsAPI.controllerModel.sunrise.mapping.SunriseMapper

beforeMap

Methods inherited from class com.kuka.roboticsAPI.controllerModel.mapping.AbstractMapper

getMapperTable, performMapping, register

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractMotionOverlayMapper

public AbstractMotionOverlayMapper()

Method Detail

map

public final void map(SunriseMappingToken info)

Description copied from class: AbstractMapper

This method is called when the mapper should map a command for which it is registered. It is to be overridden by the descendant mappers.

Specified by:

map in class AbstractMapper<SunriseMappingToken>

Parameters:

info - The mapping information for the current mapping process.

mapMotionOverlay

protected abstract void mapMotionOverlay(SunriseMappingToken info,
                                         int instance)

Maps a motion overlay.

Parameters:

info - mapping information

instance - the module instance number

getMappingTypes

public abstract Collection<Class<?>> getMappingTypes()

Description copied from class: AbstractMapper

Gets the mapping types which this mapper can map. A type can be a command or a part of a command, depending on what the mapper is able to do. For example, the type could be an IAction, an IControllerCommand or an IStopCondition.

Specified by:

getMappingTypes in class AbstractMapper<SunriseMappingToken>

Returns:

The mapping types which this mapper can map. null is not allowed.