org.jlab.coda.emu.support.codaComponent

Class CODAStateMachineAdapter

java.lang.Object

org.jlab.coda.emu.support.codaComponent.CODAStateMachineAdapter

All Implemented Interfaces:

CODAStateMachine

Direct Known Subclasses:

DataChannelAdapter, DataTransportAdapter

public class CODAStateMachineAdapter
extends java.lang.Object
implements CODAStateMachine

This class provides empty implementations of the CODAStateMachine interface. Extending this class implements the CODAStateMachine interface and frees any subclass from having to implement methods that aren't used.

Author:

timmer Date: 4/18/13

Constructor Summary

Constructors

Constructor and Description
CODAStateMachineAdapter()

Method Summary

Modifier and Type	Method and Description
void	download() This method implements the DOWNLOAD transition of the CODA run control state machine.
void	end() This method implements the END transition of the CODA run control state machine.
EmuEventNotify	getEndCallback() This method gets the callback object previously registered by the caller used to notify upon the arrival of an END event.
EmuEventNotify	getPrestartCallback() This method gets the callback object previously registered by the caller used to notify upon the arrival of a PRESTART event.
void	go() This method implements the GO transition of the CODA run control state machine.
void	pause() This method implements the PAUSE transition of the CODA run control state machine.
void	prestart() This method implements the PRESTART transition of the CODA run control state machine.
void	registerEndCallback(EmuEventNotify callback) This method allows for setting a object used to notify the caller when an END event has arrived (or any other occurrence for that matter).
void	registerPrestartCallback(EmuEventNotify callback) This method allows for setting a object used to notify the caller when a PRESTART event has arrived (or any other occurrence for that matter).
void	reset() This method implements the RESET transition of the CODA run control state machine.

Methods inherited from class java.lang.Object

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

Constructor Detail

CODAStateMachineAdapter

public CODAStateMachineAdapter()

Method Detail

go

public void go()
        throws CmdExecException

This method implements the GO transition of the CODA run control state machine.

Specified by:

go in interface CODAStateMachine

Throws:

CmdExecException - if error during command execution.

end

public void end()
         throws CmdExecException

This method implements the END transition of the CODA run control state machine.

Specified by:

end in interface CODAStateMachine

Throws:

CmdExecException - if error during command execution.

pause

public void pause()
           throws CmdExecException

This method implements the PAUSE transition of the CODA run control state machine.

Specified by:

pause in interface CODAStateMachine

Throws:

CmdExecException - if error during command execution.

prestart

public void prestart()
              throws CmdExecException

This method implements the PRESTART transition of the CODA run control state machine.

Specified by:

prestart in interface CODAStateMachine

Throws:

CmdExecException - if error during command execution.

download

public void download()
              throws CmdExecException

This method implements the DOWNLOAD transition of the CODA run control state machine.

Specified by:

download in interface CODAStateMachine

Throws:

CmdExecException - if error during command execution.

reset

public void reset()

This method implements the RESET transition of the CODA run control state machine.

Specified by:

reset in interface CODAStateMachine

registerEndCallback

public void registerEndCallback(EmuEventNotify callback)

This method allows for setting a object used to notify the caller when an END event has arrived (or any other occurrence for that matter).

Specified by:

registerEndCallback in interface CODAStateMachine

Parameters:

callback - object used for notifying caller.

getEndCallback

public EmuEventNotify getEndCallback()

This method gets the callback object previously registered by the caller used to notify upon the arrival of an END event.

Specified by:

getEndCallback in interface CODAStateMachine

Returns:

object used for notifying caller.

registerPrestartCallback

public void registerPrestartCallback(EmuEventNotify callback)

This method allows for setting a object used to notify the caller when a PRESTART event has arrived (or any other occurrence for that matter).

Specified by:

registerPrestartCallback in interface CODAStateMachine

Parameters:

callback - object used for notifying caller.

getPrestartCallback

public EmuEventNotify getPrestartCallback()

This method gets the callback object previously registered by the caller used to notify upon the arrival of a PRESTART event.

Specified by:

getPrestartCallback in interface CODAStateMachine

Returns:

object used for notifying caller.