Interface.h File Reference

#include "Messages.h"

Functions
void	DoIntroduction ()
	This will be called before anything else is done in a non-batch situation. More...
modelMsg	GetMessage ()
	This is used when the model is expecting a user message and cannot go on without one. More...
modelMsg	CheckForMessage (std::string sAppPath)
	This is used when the model is checking for a message which may have come in during processing. More...
void	SendMessage (modelMsg msg, bool batch=false)
	This function accepts a message from the sim manager. More...
void	ExternalErrorHandler (modelErr stcError, int iModelState, bool batch)
	This function accepts an error from the sim manager and processes it by displaying the appropriate error message. More...

Function Documentation

CheckForMessage()

modelMsg CheckForMessage

(

std::string

sAppPath

)

This is used when the model is checking for a message which may have come in during processing.

A return message of "no message" is acceptable if the user has not requested any actions.

For now this assumes that any keys hit by the user mean "pause", but this idea should be expanded out if significant need for message-passing is discovered.

Parameters

sAppPath

Path on which to check for a message

Returns

Any message retrieved.

DoIntroduction()

void DoIntroduction

(

)

This will be called before anything else is done in a non-batch situation.

It allows the interface to call any introductory screens, or ignore it if there's nothing to be done.

ExternalErrorHandler()

void ExternalErrorHandler	(	modelErr	stcError,
		int	iModelState,
		bool	batch
	)

This function accepts an error from the sim manager and processes it by displaying the appropriate error message.

If this is batch, different messages can be written.

Parameters

stcError	Error to be processed
iModelState	Model state - running, paused, etc
batch	Whether this is being run in batch mode

GetMessage()

modelMsg GetMessage

(

)

This is used when the model is expecting a user message and cannot go on without one.

This function will continue to listen for input until some has been received.

Returns

Message.

SendMessage()

void SendMessage	(	modelMsg	msg,
		bool	batch = false
	)

This function accepts a message from the sim manager.

Parameters

msg	Message to send
batch	Whether this is being run in batch mode