com.kuka.roboticsAPI.controllerModel.sunrise
Class ParameterConfiguration

java.lang.Object
  com.kuka.roboticsAPI.controllerModel.sunrise.ParameterConfiguration

public final class ParameterConfiguration
extends Object

Responsible for overriding compound parameters that are set in the mapping or predefined compound definitions. Can also be used for adding some parameters to compounds.

This mechanism can be used to override parameters for mapped compound in an SPR. The parameter values specified within this configuration will always be set in the specified compound, overridden previously defined values through the mapping process.

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.

Field Summary

static ParameterConfiguration

Current Gets the current mapper configuration.

Method Summary

void	addAdditionalParameters(SPR spr) Add all configured additional parameters to the specified spr.
void	addParameter(String compoundName, String paramName, Object value) Adds an additional compound parameter.
void	disableParameters(String compoundName) Disables the parameters for the specified compound.
void	enableParameters(String compoundName) Enables the previously disabled parameters for a compound.
void	removeParameter(String compoundName, String paramName) Removes an additional parameter for a compound.
void	removeParameters(String compoundName) Removes all parameters for a compound.

Methods inherited from class java.lang.Object

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

Field Detail

Current

public static final ParameterConfiguration Current

Gets the current mapper configuration.

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.

Method Detail

addAdditionalParameters

public void addAdditionalParameters(SPR spr)

Add all configured additional parameters to the specified spr.

Parameters:

spr - the SPR to which the parameters will be added.

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.

addParameter

public void addParameter(String compoundName,
                         String paramName,
                         Object value)

Adds an additional compound parameter.

Parameters:

compoundName - The name of the compound.

paramName - The name of the additional parameter.

value - The value of the additional 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.

removeParameter

public void removeParameter(String compoundName,
                            String paramName)

Removes an additional parameter for a compound.

Parameters:

compoundName - The name of the compound.

paramName - 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.

removeParameters

public void removeParameters(String compoundName)

Removes all parameters for a compound.

Parameters:

compoundName - The name of the compound.

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.

enableParameters

public void enableParameters(String compoundName)

Enables the previously disabled parameters for a compound.

Parameters:

compoundName - The name of the compound.

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.

disableParameters

public void disableParameters(String compoundName)

Disables the parameters for the specified compound. They can be enabled afterwards.

Parameters:

compoundName - The name of the compound.

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.