org.eclipse.basyx.models.controlcomponent

Class ControlComponent

java.lang.Object

java.util.AbstractMap<K,V>

java.util.HashMap<String,Object>

org.eclipse.basyx.models.controlcomponent.ControlComponent

All Implemented Interfaces:

Serializable, Cloneable, Map<String,Object>

Direct Known Subclasses:

SimpleControlComponent

public abstract class ControlComponent
extends HashMap<String,Object>

BaSys 4.0 control component interface. This is a VAB object that cannot be serialized.

Author:

kuhn

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Field Summary

Fields

Modifier and Type	Field and Description
static String	CMD
static String	ERROR_STATE
static String	EX_MODE
static String	EX_STATE
static String	OCCUPATION_STATE
static String	OCCUPIER
static String	OP_MODE
static String	OPERATION_ABORT
static String	OPERATION_AUTO
static String	OPERATION_CLEAR
static String	OPERATION_FREE
static String	OPERATION_MANUAL
static String	OPERATION_OCCUPY
static String	OPERATION_PRIORITY
static String	OPERATION_RESET
static String	OPERATION_START
static String	OPERATION_STOP
static String	OPERATIONS
static String	STATUS
static String	WORK_STATE

Constructor Summary

Constructors

Constructor and Description
ControlComponent() Constructor

Method Summary

Modifier and Type	Method and Description
void	addControlComponentChangeListener(ControlComponentChangeListener listener) Add ControlComponentChangeListener
void	finishState() Finish current execution state (execute 'SC' order).
String	getCommand() Get last command
String	getErrorState() Get error state
ExecutionMode	getExecutionMode() Get execution mode
String	getExecutionState() Get execution state
OccupationState	getOccupationState() Get occupation state
String	getOccupierID() Get occupier ID
String	getOperationMode() Get operation mode
String	getWorkState() Get work state
Object	put(String key, Object value) Update an value
void	removeControlComponentChangeListener(ControlComponentChangeListener listener) Remove ControlComponentChangeListener
void	setCommand(String cmd) Set command
void	setErrorState(String errorState) Set error state
void	setExecutionMode(ExecutionMode exMode) Set execution mode
void	setExecutionState(String newSt) Set execution state
void	setOccupationState(OccupationState occSt) Set occupation state
void	setOccupierID(String occId) Set occupier ID
void	setOperationMode(String opMode) Set operation mode
void	setWorkState(String workState) Set work state

Methods inherited from class java.util.HashMap

clear, clone, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, forEach, get, getOrDefault, isEmpty, keySet, merge, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

Methods inherited from class java.util.AbstractMap

equals, hashCode, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

equals, hashCode

Field Detail

STATUS

public static final String STATUS

See Also:

Constant Field Values

OPERATIONS

public static final String OPERATIONS

See Also:

Constant Field Values

OPERATION_CLEAR

public static final String OPERATION_CLEAR

See Also:

Constant Field Values

OPERATION_STOP

public static final String OPERATION_STOP

See Also:

Constant Field Values

OPERATION_ABORT

public static final String OPERATION_ABORT

See Also:

Constant Field Values

OPERATION_RESET

public static final String OPERATION_RESET

See Also:

Constant Field Values

OPERATION_START

public static final String OPERATION_START

See Also:

Constant Field Values

OPERATION_MANUAL

public static final String OPERATION_MANUAL

See Also:

Constant Field Values

OPERATION_AUTO

public static final String OPERATION_AUTO

See Also:

Constant Field Values

OPERATION_PRIORITY

public static final String OPERATION_PRIORITY

See Also:

Constant Field Values

OPERATION_OCCUPY

public static final String OPERATION_OCCUPY

See Also:

Constant Field Values

OPERATION_FREE

public static final String OPERATION_FREE

See Also:

Constant Field Values

CMD

public static final String CMD

See Also:

Constant Field Values

ERROR_STATE

public static final String ERROR_STATE

See Also:

Constant Field Values

WORK_STATE

public static final String WORK_STATE

See Also:

Constant Field Values

OP_MODE

public static final String OP_MODE

See Also:

Constant Field Values

EX_STATE

public static final String EX_STATE

See Also:

Constant Field Values

EX_MODE

public static final String EX_MODE

See Also:

Constant Field Values

OCCUPIER

public static final String OCCUPIER

See Also:

Constant Field Values

OCCUPATION_STATE

public static final String OCCUPATION_STATE

See Also:

Constant Field Values

Constructor Detail

ControlComponent

public ControlComponent()

Constructor

Method Detail

addControlComponentChangeListener

public void addControlComponentChangeListener(ControlComponentChangeListener listener)

Add ControlComponentChangeListener

removeControlComponentChangeListener

public void removeControlComponentChangeListener(ControlComponentChangeListener listener)

Remove ControlComponentChangeListener

put

public Object put(String key,
                  Object value)

Update an value

Specified by:

put in interface Map<String,Object>

Overrides:

put in class HashMap<String,Object>

Returns:

Added value

finishState

public void finishState()

Finish current execution state (execute 'SC' order). This only works in transition states

getOccupationState

public OccupationState getOccupationState()

Get occupation state

setOccupationState

public void setOccupationState(OccupationState occSt)

Set occupation state

getOccupierID

public String getOccupierID()

Get occupier ID

setOccupierID

public void setOccupierID(String occId)

Set occupier ID

getExecutionMode

public ExecutionMode getExecutionMode()

Get execution mode

setExecutionMode

public void setExecutionMode(ExecutionMode exMode)

Set execution mode

getExecutionState

public String getExecutionState()

Get execution state

setExecutionState

public void setExecutionState(String newSt)

Set execution state

getOperationMode

public String getOperationMode()

Get operation mode

setOperationMode

public void setOperationMode(String opMode)

Set operation mode

getWorkState

public String getWorkState()

Get work state

setWorkState

public void setWorkState(String workState)

Set work state

getErrorState

public String getErrorState()

Get error state

setErrorState

public void setErrorState(String errorState)

Set error state

getCommand

public String getCommand()

Get last command

setCommand

public void setCommand(String cmd)

Set command