com.kuka.roboticsAPI.controllerModel
Class DispatchedEventData

java.lang.Object
  com.kuka.roboticsAPI.controllerModel.DispatchedEventData

public class DispatchedEventData
extends Object

Details about an event that occurred in the system. DispatchedEvents are not permanent state changes, like StatePorts, but rather just events that do not modify a module's states, they only describe a smaller happening.

Constructor Summary

DispatchedEventData(String componentName, String eventName, com.kuka.roboticsAPI.controllerModel.DispatchedEventState eventState, Date timeStamp, String kxrTranslationModuleName)
Creates a new DispatchedEventData object from the given parameters and the current time.

DispatchedEventData(String componentName, String eventName, com.kuka.roboticsAPI.controllerModel.DispatchedEventState eventState, String kxrTranslationModuleName)
Creates a new DispatchedEventData object from the given parameters and the current time.

Method Summary

void	addParam(String key, String value) Adds a parameter and key pair to the data object.
String	getComponentName() the name of the component that dispatched the event.
String	getEventName() the name of the event.
com.kuka.roboticsAPI.controllerModel.DispatchedEventState	getEventState() the overall state of the event.
Map<String,String>	getEventValues() gets the LinkedHashMap containing the event values.
String	getKXRTranslationModuleName() gets the module name of the KXR translation file.
String	getPropertyNames() gets the changed property names.
String	getPropertyValues() gets changed properties' actual values in string.
String	getRobotName() gets the name of the source robot.
Date	getTimestamp() the time when the event occurred.
void	removeParam(String key) Removes a parameter from the data object identified by the given key.
void	setRobotName(String robotName) Sets the name of the source robot.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

DispatchedEventData

public DispatchedEventData(String componentName,
                           String eventName,
                           com.kuka.roboticsAPI.controllerModel.DispatchedEventState eventState,
                           Date timeStamp,
                           String kxrTranslationModuleName)

Creates a new DispatchedEventData object from the given parameters and the current time.

Parameters:

componentName - name of the sender component

eventName - name of the event that occurred

eventState - the state of the event

timeStamp - the time when the event occurred

kxrTranslationModuleName - the module name referenced from the kxr file

DispatchedEventData

public DispatchedEventData(String componentName,
                           String eventName,
                           com.kuka.roboticsAPI.controllerModel.DispatchedEventState eventState,
                           String kxrTranslationModuleName)

Creates a new DispatchedEventData object from the given parameters and the current time.

Parameters:

componentName - name of the sender component

eventName - name of the event that occurred

eventState - the state of the event

kxrTranslationModuleName - the module name referenced from the kxr file

Method Detail

addParam

public void addParam(String key,
                     String value)

Adds a parameter and key pair to the data object.

Parameters:

key - the string key of the parameter to be added

value - the string value of the parameter

removeParam

public void removeParam(String key)

Removes a parameter from the data object identified by the given key.

Parameters:

key - the string key of the parameter to be removed

getComponentName

public String getComponentName()

the name of the component that dispatched the event.

Returns:

the name of the component that dispatched the event.

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.

getEventName

public String getEventName()

the name of the event.

Returns:

the name of the event.

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.

getEventState

public com.kuka.roboticsAPI.controllerModel.DispatchedEventState getEventState()

the overall state of the event.

Returns:

the overall state of the event.

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.

getEventValues

public Map<String,String> getEventValues()

gets the LinkedHashMap containing the event values.

Returns:

the eventValues

getPropertyNames

public String getPropertyNames()

gets the changed property names.

Returns:

the eventValues

getPropertyValues

public String getPropertyValues()

gets changed properties' actual values in string.

Returns:

the eventValues

getTimestamp

public Date getTimestamp()

the time when the event occurred.

Returns:

the time when the event occurred.

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.

getKXRTranslationModuleName

public String getKXRTranslationModuleName()

gets the module name of the KXR translation file.

Returns:

the module name of the KXR translation file.

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.

getRobotName

public String getRobotName()

gets the name of the source robot. Returns empty string if the source is the Station

Returns:

the name of the source robot, empty string if the source is the Station

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.

setRobotName

public void setRobotName(String robotName)

Sets the name of the source robot. Empty string means the source is the Station

Parameters:

robotName - the name of the source robot, empty string if the source is the Station

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.

toString

public String toString()

Overrides:

toString in class Object