com.kuka.roboticsAPI
Class BootStateControllerInitializationBehaviour

java.lang.Object
  com.kuka.roboticsAPI.BootStateControllerInitializationBehaviour

All Implemented Interfaces:

IControllerInitializeBehaviour

public class BootStateControllerInitializationBehaviour
extends Object
implements IControllerInitializeBehaviour

Controller initialize behavior that monitors the boot states of the controller.

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

BootStateControllerInitializationBehaviour()

Method Summary

void	addControllerListener(IControllerBootStateListener listener) Adds a listener.
void	afterInitialize(Controller controller) Called from the afterInitialize method of the controller.
void	dispose() Disposes this instance.
protected void	fireControllerBootStateChanged(Controller contr) Informs all listeners about a change of the boot state of the controller.
String	getBootErrorDetails(Controller controller) Gets the boot state of the controller.
ControllerBootInfo	getBootInfo(Controller controller) Gets the boot info object of the controller.
com.kuka.roboticsAPI.controllerModel.ControllerBootState	getBootState(Controller controller) Gets the boot state of the controller.
void	initializationError(Controller controller, RuntimeException ex) Handles exceptions that occur during the initialization phase of the controller.
void	initialize(Controller controller) Initializes the behavior with default values.
void	onEvent(Controller controller, String event, Message eventMessage) Handles events that occurred on the controller.
void	onInitialize(Controller controller) Called from the onInitialize method of the controller.
void	removeControllerListener(IControllerBootStateListener listener) Removes a listener.
void	setBootErrorTimeout(int value) Sets the maximum timeout (in ms) for the onInitialize method.

Methods inherited from class java.lang.Object

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

Constructor Detail

BootStateControllerInitializationBehaviour

public BootStateControllerInitializationBehaviour()

Method Detail

addControllerListener

public void addControllerListener(IControllerBootStateListener listener)

Adds a listener. The listener is informed when controller state is changed.

Parameters:

listener - The listener that will be registered. null is not allowed.

The same listener instance can be registered only once. Multiple registration attempts for the same listener instance will be ignored.

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.

removeControllerListener

public void removeControllerListener(IControllerBootStateListener listener)

Removes a listener. The listener is removed from the list of listener that are informed when safety state is changed.

Parameters:

listener - The listener that will be unregistered. null is not allowed.

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.

initialize

public void initialize(Controller controller)

Initializes the behavior with default values.

Specified by:

initialize in interface IControllerInitializeBehaviour

Parameters:

controller - the corresponding controller

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.

onInitialize

public void onInitialize(Controller controller)

Called from the onInitialize method of the controller.

Specified by:

onInitialize in interface IControllerInitializeBehaviour

Parameters:

controller - the corresponding controller

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.

afterInitialize

public void afterInitialize(Controller controller)

Called from the afterInitialize method of the controller.

Specified by:

afterInitialize in interface IControllerInitializeBehaviour

Parameters:

controller - the corresponding controller

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.

onEvent

public void onEvent(Controller controller,
                    String event,
                    Message eventMessage)

Handles events that occurred on the controller.

Specified by:

onEvent in interface IControllerInitializeBehaviour

Parameters:

controller - the corresponding controller

event - the occurred event

eventMessage - received event message

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.

fireControllerBootStateChanged

protected void fireControllerBootStateChanged(Controller contr)

Informs all listeners about a change of the boot state of the controller.

Parameters:

contr - the controller with the changed boot state.

initializationError

public void initializationError(Controller controller,
                                RuntimeException ex)

Handles exceptions that occur during the initialization phase of the controller.

Specified by:

initializationError in interface IControllerInitializeBehaviour

Parameters:

controller - the corresponding controller

ex - exception that was thrown

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.

getBootState

public com.kuka.roboticsAPI.controllerModel.ControllerBootState getBootState(Controller controller)

Gets the boot state of the controller.

Parameters:

controller - the controller

Returns:

the boot state of the controller

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.

getBootInfo

public ControllerBootInfo getBootInfo(Controller controller)

Gets the boot info object of the controller.

Parameters:

controller - the controller

Returns:

boot info 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.

getBootErrorDetails

public String getBootErrorDetails(Controller controller)

Gets the boot state of the controller.

Parameters:

controller - the controller

Returns:

the boot state of the controller.

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.

setBootErrorTimeout

public void setBootErrorTimeout(int value)

Sets the maximum timeout (in ms) for the onInitialize method.

Parameters:

value - the maximum timeout (in ms) for the onInitialize method.

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.

dispose

public void dispose()

Disposes this instance.