org.jlab.coda.emu.support.codaComponent

Interface CODAStateMachine

All Known Subinterfaces:

DataChannel, DataTransport, EmuModule

All Known Implementing Classes:

CODAStateMachineAdapter, DataChannelAdapter, DataChannelImplCmsg, DataChannelImplEmu, DataChannelImplEt, DataChannelImplFifo, DataChannelImplFile, DataTransportAdapter, DataTransportImplCmsg, DataTransportImplEmu, DataTransportImplEt, DataTransportImplFifo, DataTransportImplFile, Dummy, EventRecording, FarmController, FastEventBuilder, ModuleAdapter, RocFixedRateSimulation, RocSimulation, ToFile, TsFixedRateSimulation, TsSimulation

public interface CODAStateMachine

This interface is used when defining data transports, data channels, and modules. It encompasses all state machine functions and the ability to notify others of an END event's arrival.

Author:

timmer Date: 4/18/13

See Also:

CODATransition

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.

Method Detail

go

void go()
 throws CmdExecException

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

Throws:

CmdExecException - if error during command execution.

end

void end()
  throws CmdExecException

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

Throws:

CmdExecException - if error during command execution.

pause

void pause()
    throws CmdExecException

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

Throws:

CmdExecException - if error during command execution.

prestart

void prestart()
       throws CmdExecException

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

Throws:

CmdExecException - if error during command execution.

download

void download()
       throws CmdExecException

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

Throws:

CmdExecException - if error during command execution.

reset

void reset()

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

registerEndCallback

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).

Parameters:

callback - object used for notifying caller.

getEndCallback

EmuEventNotify getEndCallback()

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

Returns:

object used for notifying caller.

registerPrestartCallback

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).

Parameters:

callback - object used for notifying caller.

getPrestartCallback

EmuEventNotify getPrestartCallback()

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

Returns:

object used for notifying caller.