com.kuka.roboticsAPI.controllerModel
Class StatePortData

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

public class StatePortData
extends Object

Details about the state ports. State ports contains details about the system state, such as error states.

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.

Nested Class Summary

static class

StatePortData.PropertyState Details about the state of an state port.

Constructor Summary

StatePortData(String componentName, String portName, String changedProperty, com.kuka.roboticsAPI.controllerModel.StatePortState portState, Date timestamp, String kxrModuleName, List<StatePortData.PropertyState> states)
Constructor.

Method Summary

boolean	equals(Object obj)
String	getChangedProperty() gets the ID of the changed property.
String	getComponentName() the name of the component that owns the state port.
String	getKXRTranslationModuleName() gets the module name of the KXR translation file.
String	getPortName() the name of the state port.
com.kuka.roboticsAPI.controllerModel.StatePortState	getPortState() the overall state of the state port.
List<StatePortData.PropertyState>	getStates() details about the states that lead to the state port change.
Date	getTimestamp() the time when the state port change occurred.
int	hashCode()
protected void	resetError() resets the state port from the error state.
protected void	setError(List<StatePortData.PropertyState> states) Sets the state port to state Error.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

StatePortData

public StatePortData(String componentName,
                     String portName,
                     String changedProperty,
                     com.kuka.roboticsAPI.controllerModel.StatePortState portState,
                     Date timestamp,
                     String kxrModuleName,
                     List<StatePortData.PropertyState> states)

Constructor.

Parameters:

componentName - name of the component

portName - name of the port

changedProperty - changed property

portState - state of the port

timestamp - time

kxrModuleName - name of the KXR Translation file

states - property states that lead to the state port state.

Method Detail

hashCode

public int hashCode()

Overrides:

hashCode in class Object

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.

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

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.

setError

protected void setError(List<StatePortData.PropertyState> states)

Sets the state port to state Error.

Parameters:

states - the states that lead to the error state.

resetError

protected void resetError()

resets the state port from the error state.

getComponentName

public String getComponentName()

the name of the component that owns the state port.

Returns:

the name of the component that owns the state port.

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.

getPortName

public String getPortName()

the name of the state port.

Returns:

the name of the state port.

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.

getPortState

public com.kuka.roboticsAPI.controllerModel.StatePortState getPortState()

the overall state of the state port.

Returns:

the overall state of the state port.

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.

getChangedProperty

public String getChangedProperty()

gets the ID of the changed property.

Returns:

the ID of the changed property

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.

getTimestamp

public Date getTimestamp()

the time when the state port change occurred.

Returns:

the time when the state port change 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.

toString

public String toString()

Overrides:

toString in class Object

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.

getStates

public List<StatePortData.PropertyState> getStates()

details about the states that lead to the state port change.

Returns:

details about the states that lead to the state port change.

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.