com.kuka.roboticsAPI.persistenceModel.processDataModel
Interface IProcessData

public interface IProcessData

Generic interface describing a process data element.

Method Summary

void	addProcessDataListener(IProcessDataListener listener) Register a listener for events by the process data element.
String	getComment() Gets the comment of the process data element.
Class<?>	getDataType() Gets the data type of the process data value.
<T extends Serializable> T	getDefaultValue() Gets the default value for the process data element.
String	getDisplayName() Gets the display name shown on the HMI.
String	getId() Gets the unique ID of the process data element.
Number	getMax() Gets the defined maximum value of the process data element.
Number	getMin() Gets the defined minimum value of the process data element.
String	getUnit() Gets the user defined unit of the process data element.
<T extends Serializable> T	getValue() Gets the persistent process data value.
boolean	isEditableOnHmi() Flag that signifies whether the process data element is editable on the HMI.
boolean	isVisibleOnHmi() Flag that signifies whether the process data element is visible on the HMI.
void	removeApplicationProcessDataListeners() Remove registered IProcessDataListeners.
void	removeProcessDataListener(IProcessDataListener listener) Unregister a process data listener.
void	setComment(String comment) Sets the comment of the process data element.
void	setDefaultValue(Serializable value) Sets the default value for the process data element.
void	setMax(Number max) Sets the defined maximum value of the process data element.
void	setMin(Number min) Sets the defined minimum value of the process data element.
void	setValue(Serializable value) Sets the value of the process data element.

Method Detail

addProcessDataListener

void addProcessDataListener(IProcessDataListener listener)

Register a listener for events by the process data element.

Parameters:

listener - to be registered

removeProcessDataListener

void removeProcessDataListener(IProcessDataListener listener)

Unregister a process data listener.

Parameters:

listener - to be unregistered

removeApplicationProcessDataListeners

void removeApplicationProcessDataListeners()

Remove registered IProcessDataListeners. Instances of ISystemProcessDataListener will not be removed, so they will survive application termination.

getId

String getId()

Gets the unique ID of the process data element.

Returns:

The unique ID as String

getDisplayName

String getDisplayName()

Gets the display name shown on the HMI.

Returns:

The display name as String

getValue

<T extends Serializable> T getValue()

Gets the persistent process data value.

Type Parameters:

T - The data type defined in the process data

Returns:

The value of the process data element. The return type relates to the data type defined in the data source.

setValue

void setValue(Serializable value)

Sets the value of the process data element. Must be the same data type as defined during creation.

Parameters:

value - The value to be set

getDefaultValue

<T extends Serializable> T getDefaultValue()

Gets the default value for the process data element.

Type Parameters:

T - The value type defined in the process data

Returns:

The default value of the process data element

setDefaultValue

void setDefaultValue(Serializable value)

Sets the default value for the process data element.

Parameters:

value - The value that will be used as default for the process data element

getDataType

Class<?> getDataType()

Gets the data type of the process data value.

Returns:

The class of the process data value

getMin

Number getMin()

Gets the defined minimum value of the process data element.

Returns:

The minimum of the process data value

setMin

void setMin(Number min)

Sets the defined minimum value of the process data element.

Parameters:

min - The minimum of the process data value

getMax

Number getMax()

Gets the defined maximum value of the process data element.

Returns:

The maximum of the process data value

setMax

void setMax(Number max)

Sets the defined maximum value of the process data element.

Parameters:

max - The maximum of the process data value

getUnit

String getUnit()

Gets the user defined unit of the process data element.

Returns:

the unit of the data as String

getComment

String getComment()

Gets the comment of the process data element.

Returns:

the comment as String

setComment

void setComment(String comment)

Sets the comment of the process data element.

Parameters:

comment - The comment to set

isEditableOnHmi

boolean isEditableOnHmi()

Flag that signifies whether the process data element is editable on the HMI.

Returns:

true, if the process data element is editable

isVisibleOnHmi

boolean isVisibleOnHmi()

Flag that signifies whether the process data element is visible on the HMI.

Returns:

true, if the process data element is visible