com.kuka.roboticsAPI.controllerModel.sunrise.predefinedCompounds
Class ConditionEvaluatorModule

java.lang.Object
  com.kuka.roboticsAPI.controllerModel.sunrise.api.SPRComponent
      com.kuka.roboticsAPI.controllerModel.sunrise.api.Module
          com.kuka.roboticsAPI.controllerModel.sunrise.predefinedCompounds.ConditionEvaluatorModule

All Implemented Interfaces:

com.kuka.common.IDataEquatable, IExpressionSegment, ISprComponent, ISegment

public class ConditionEvaluatorModule
extends Module

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

ConditionEvaluatorModule()
Creates a new condition evaluating module.

ConditionEvaluatorModule(String dfeName)
Creates a new condition evaluating module for common DFEs.

Method Summary

int	addTriggerParameter(String conditionString, ICondition condition) Adds a trigger parameter to the condition evaluator.
int	getConditionId(ICondition condition) Provides the id of the specified condition.
void	mapNotificationType(NotificationType nType) Maps the notification type for all conditions.
int	registerCondition(ICondition condition, String edge, String parametrizeConditionEvaluatorModule) Adds a condition to evaluate.
void	removeNotificationOnEnable() Removes the notification about the current state of the condition.

Methods inherited from class com.kuka.roboticsAPI.controllerModel.sunrise.api.Module

getComponentType, getComponentVersion

Methods inherited from class com.kuka.roboticsAPI.controllerModel.sunrise.api.SPRComponent

addInPort, addInPort, addOutPort, addOutPort, addParameter, getChecksum, getExpressionSegmentString, getInPort, getInPorts, getInstanceName, getName, getOutPort, getOutPorts, getParameter, getParameterList, getSPR, hasSameDataAs, onAsyncEvent, onFinished, onInitialize, onSerialization, onSPRStateChanged, onSPRStateChangedSync, setInstanceName, setName, toString, tryGetParameter

Methods inherited from class java.lang.Object

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

Constructor Detail

ConditionEvaluatorModule

public ConditionEvaluatorModule()

Creates a new condition evaluating module.

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.

ConditionEvaluatorModule

public ConditionEvaluatorModule(String dfeName)

Creates a new condition evaluating module for common DFEs.

Parameters:

dfeName - name of the DFE

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

addTriggerParameter

public int addTriggerParameter(String conditionString,
                               ICondition condition)

Adds a trigger parameter to the condition evaluator.

Parameters:

conditionString - condition string

condition - the condition

Returns:

Number of registered conditions.

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.

registerCondition

public int registerCondition(ICondition condition,
                             String edge,
                             String parametrizeConditionEvaluatorModule)

Adds a condition to evaluate.

Parameters:

condition - The condition to evaluate.

edge - Which event changes to be notified about (rising edge, falling edge, any edge).

parametrizeConditionEvaluatorModule - the condition string.

Returns:

Number of registered conditions.

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.

removeNotificationOnEnable

public void removeNotificationOnEnable()

Removes the notification about the current state of the condition.

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.

getConditionId

public int getConditionId(ICondition condition)

Provides the id of the specified condition.

condition indexing is one-based, i.e. numbering starts at one

Parameters:

condition - The condition of which the id is wanted.

Returns:

id of the condition

mapNotificationType

public void mapNotificationType(NotificationType nType)

Maps the notification type for all conditions.

Parameters:

nType - the notification type.

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.