com.kuka.roboticsAPI.controllerModel
Class ControllerBootInfo

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

public class ControllerBootInfo
extends Object

Contains information about a 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

ControllerBootInfo(String controllerName)
Default constructor.

ControllerBootInfo(String controllerName, com.kuka.roboticsAPI.controllerModel.ControllerBootState state, com.kuka.roboticsAPI.controllerModel.ControllerBootErrorReason reason, String details)
Initialization constructor.

Method Summary

boolean	equals(Object obj)
String	getDetails() gets details about the boot error / warning.
com.kuka.roboticsAPI.controllerModel.ControllerBootErrorReason	getReason() gets the current boot error reason.
com.kuka.roboticsAPI.controllerModel.ControllerBootState	getState() gets the current boot state.
int	hashCode()
void	setBootingState() Sets the state to booting.
void	setErrorState(com.kuka.roboticsAPI.controllerModel.ControllerBootErrorReason reason, String details) sets the state to error.
void	setRunningState() Sets the state to running.
void	setState(com.kuka.roboticsAPI.controllerModel.ControllerBootState state, com.kuka.roboticsAPI.controllerModel.ControllerBootErrorReason reason, String details) sets the state.
void	setWarningState(com.kuka.roboticsAPI.controllerModel.ControllerBootErrorReason reason, String details) Sets the state to warning.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ControllerBootInfo

public ControllerBootInfo(String controllerName)

Default constructor.

Parameters:

controllerName - name 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.

ControllerBootInfo

public ControllerBootInfo(String controllerName,
                          com.kuka.roboticsAPI.controllerModel.ControllerBootState state,
                          com.kuka.roboticsAPI.controllerModel.ControllerBootErrorReason reason,
                          String details)

Initialization constructor.

Parameters:

controllerName - name of the controller.

state - boot state

reason - boot error reason

details - boot error details

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

setRunningState

public void setRunningState()

Sets the state to running.

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.

setBootingState

public void setBootingState()

Sets the state to booting.

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.

setWarningState

public void setWarningState(com.kuka.roboticsAPI.controllerModel.ControllerBootErrorReason reason,
                            String details)

Sets the state to warning.

Parameters:

reason - reason for the warning

details - further details

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.

setErrorState

public void setErrorState(com.kuka.roboticsAPI.controllerModel.ControllerBootErrorReason reason,
                          String details)

sets the state to error.

Parameters:

reason - reason for the error

details - further details

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.

setState

public void setState(com.kuka.roboticsAPI.controllerModel.ControllerBootState state,
                     com.kuka.roboticsAPI.controllerModel.ControllerBootErrorReason reason,
                     String details)

sets the state.

Parameters:

state - state to set

reason - reason for error / warning

details - further details

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.

getState

public com.kuka.roboticsAPI.controllerModel.ControllerBootState getState()

gets the current boot state.

Returns:

the current boot state

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.

getReason

public com.kuka.roboticsAPI.controllerModel.ControllerBootErrorReason getReason()

gets the current boot error reason.

Returns:

current boot error reason

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.

getDetails

public String getDetails()

gets details about the boot error / warning.

Returns:

details about the boot error / warning

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.

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.

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.