nl.tno.imb.mc

Class ModelStarter

java.lang.Object

nl.tno.imb.mc.ModelStarter

public abstract class ModelStarter
extends Object

Model starter.

Field Summary

Fields

Modifier and Type	Field and Description
(package private) static String	CLIENTS_ROOT_EVENT_NAME Default clients root event name.
protected TConnection	connection Connection to the IMB hub.
(package private) static String	CONTROLLER_PRIVATE_EVENT_NAME_SWITCH Command line Controller private event name switch.
(package private) static String	CONTROLLER_SWITCH Command line controller switch.
(package private) static String	CONTROLLERS_EVENT_NAME_SWITCH Command line controllers event name switch.
(package private) static String	CONTROLLERS_ROOT_EVENT_NAME Controllers root event name.
(package private) static String	DATA_SOURCE_PARAMETER_NAME Data source parameter name.
(package private) static String	DEFAULT_CONTROLLER The default controller.
(package private) static String	DEFAULT_IDLE_FEDERATION Default idle federation.
(package private) static String	DEFAULT_MODEL_ID Default model id (must be numeric).
(package private) static String	DEFAULT_MODEL_NAME Default for model name.
(package private) static String	DEFAULT_MODEL_PRIORITY Default model priority.
(package private) static String	DEFAULT_REMOTE_HOST Default remote host.
(package private) static String	DEFAULT_REMOTE_PORT Default remote port.
(package private) static String	EVENT_NAME_PART_SEPARATOR Event name part separator.
(package private) static String	FEDERATION_PARAMETER_NAME Federation parameter name.
(package private) static String	IDLE_FEDERATION_SWITCH Command line idle federation switch.
(package private) static String	LINK_ID_SWITCH Command line link id switch.
(package private) static String	MODEL_ID_SWITCH Command line model id switch.
(package private) static String	MODEL_NAME_SWITCH Command line model name switch.
(package private) static String	MODEL_PRIORITY_SWITCH Command line model priority switch.
(package private) int	priority Priority.
(package private) int	progress Progress.
(package private) static String	REMOTE_HOST_SWITCH Command line remote host switch.
(package private) static String	REMOTE_PORT_SWITCH Command line remote port switch.
(package private) ModelState	state State of the model.

Constructor Summary

Constructors

Constructor and Description
ModelStarter(String[] args, String providedModelName, int providedModelId) Create a new ModelStarter.

Method Summary

Modifier and Type	Method and Description
void	doQuitApplication() Terminate the application.
void	doStartModel(ModelParameters parameters) Start a model.
void	doStopModel() Stop the model and go to idle state.
String	getRemoteHost() Retrieve the remote host name.
int	getRemotePort() Retrieve the remote port number.
(package private) void	handleControlEvents(TEventEntry event, TByteBuffer payload) Execute a control event.
abstract void	parameterRequest(ModelParameters parameters) The model must fill in its parameters.
abstract void	quitApplication() Kill the model; called before this application exits.
void	signalModelProgress(int currentProgress) Report a new progress value.
void	signalModelState(ModelState newState) Inform our federation about a state change.
void	signalModelState(ModelState newState, String federation) Inform a federation about a state change.
abstract void	startModel(ModelParameters parameters, TConnection imbConnection) Start the model.
abstract void	stopModel() Stop the model.

Methods inherited from class java.lang.Object

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

Field Detail

CONTROLLERS_ROOT_EVENT_NAME

static final String CONTROLLERS_ROOT_EVENT_NAME

Controllers root event name.

See Also:

Constant Field Values

CLIENTS_ROOT_EVENT_NAME

static final String CLIENTS_ROOT_EVENT_NAME

Default clients root event name.

See Also:

Constant Field Values

FEDERATION_PARAMETER_NAME

static final String FEDERATION_PARAMETER_NAME

Federation parameter name.

See Also:

Constant Field Values

DATA_SOURCE_PARAMETER_NAME

static final String DATA_SOURCE_PARAMETER_NAME

Data source parameter name.

See Also:

Constant Field Values

REMOTE_HOST_SWITCH

static final String REMOTE_HOST_SWITCH

Command line remote host switch.

See Also:

Constant Field Values

DEFAULT_REMOTE_HOST

static final String DEFAULT_REMOTE_HOST

Default remote host.

See Also:

Constant Field Values

REMOTE_PORT_SWITCH

static final String REMOTE_PORT_SWITCH

Command line remote port switch.

See Also:

Constant Field Values

DEFAULT_REMOTE_PORT

static final String DEFAULT_REMOTE_PORT

Default remote port.

See Also:

Constant Field Values

IDLE_FEDERATION_SWITCH

static final String IDLE_FEDERATION_SWITCH

Command line idle federation switch.

See Also:

Constant Field Values

DEFAULT_IDLE_FEDERATION

static final String DEFAULT_IDLE_FEDERATION

Default idle federation.

See Also:

Constant Field Values

LINK_ID_SWITCH

static final String LINK_ID_SWITCH

Command line link id switch.

See Also:

Constant Field Values

CONTROLLERS_EVENT_NAME_SWITCH

static final String CONTROLLERS_EVENT_NAME_SWITCH

Command line controllers event name switch.

See Also:

Constant Field Values

CONTROLLER_PRIVATE_EVENT_NAME_SWITCH

static final String CONTROLLER_PRIVATE_EVENT_NAME_SWITCH

Command line Controller private event name switch.

See Also:

Constant Field Values

CONTROLLER_SWITCH

static final String CONTROLLER_SWITCH

Command line controller switch.

See Also:

Constant Field Values

DEFAULT_CONTROLLER

static final String DEFAULT_CONTROLLER

The default controller.

See Also:

Constant Field Values

EVENT_NAME_PART_SEPARATOR

static final String EVENT_NAME_PART_SEPARATOR

Event name part separator.

See Also:

Constant Field Values

MODEL_NAME_SWITCH

static final String MODEL_NAME_SWITCH

Command line model name switch.

See Also:

Constant Field Values

DEFAULT_MODEL_NAME

static final String DEFAULT_MODEL_NAME

Default for model name.

See Also:

Constant Field Values

MODEL_ID_SWITCH

static final String MODEL_ID_SWITCH

Command line model id switch.

See Also:

Constant Field Values

DEFAULT_MODEL_ID

static final String DEFAULT_MODEL_ID

Default model id (must be numeric).

See Also:

Constant Field Values

MODEL_PRIORITY_SWITCH

static final String MODEL_PRIORITY_SWITCH

Command line model priority switch.

See Also:

Constant Field Values

DEFAULT_MODEL_PRIORITY

static final String DEFAULT_MODEL_PRIORITY

Default model priority.

See Also:

Constant Field Values

connection

protected final TConnection connection

Connection to the IMB hub.

state

ModelState state

State of the model.

priority

int priority

Priority.

progress

int progress

Progress.

Constructor Detail

ModelStarter

public ModelStarter(String[] args,
                    String providedModelName,
                    int providedModelId)
             throws IMBException

Create a new ModelStarter.

Parameters:

args - String[]; the command line arguments

providedModelName - String; name of the model

providedModelId - int; id of the model

Throws:

IMBException

Method Detail

startModel

public abstract void startModel(ModelParameters parameters,
                                TConnection imbConnection)

Start the model.

Parameters:

parameters - ModelParameters

imbConnection - TConnection; connection to the IMB hub

stopModel

public abstract void stopModel()

Stop the model.

quitApplication

public abstract void quitApplication()

Kill the model; called before this application exits.

parameterRequest

public abstract void parameterRequest(ModelParameters parameters)

The model must fill in its parameters.

Parameters:

parameters - ModelParameters

doStartModel

public void doStartModel(ModelParameters parameters)
                  throws IMBException

Start a model.

Parameters:

parameters - ModelParameters; the parameters needed to start the model

Throws:

IMBException - ...

doStopModel

public void doStopModel()
                 throws IMBException

Stop the model and go to idle state.

Throws:

IMBException - ...

doQuitApplication

public void doQuitApplication()

Terminate the application.

handleControlEvents

void handleControlEvents(TEventEntry event,
                         TByteBuffer payload)
                  throws IMBException

Execute a control event.

Parameters:

event - TEventEntry; the event

payload - TByteBuffer; details of the event

Throws:

IMBException - when the payload is malformed.

signalModelProgress

public void signalModelProgress(int currentProgress)
                         throws IMBException

Report a new progress value.

Parameters:

currentProgress - int; the new progress value

Throws:

IMBException

signalModelState

public void signalModelState(ModelState newState,
                             String federation)
                      throws IMBException

Inform a federation about a state change.

Parameters:

newState - ModelState; the new state

federation - String; the federation

Throws:

IMBException - ...

signalModelState

public void signalModelState(ModelState newState)
                      throws IMBException

Inform our federation about a state change.

Parameters:

newState - ModelState; the new state

Throws:

IMBException - ...

getRemotePort

public int getRemotePort()

Retrieve the remote port number.

Returns:

int; the remote port number

getRemoteHost

public String getRemoteHost()

Retrieve the remote host name.

Returns:

String; the name of the remote host