Interface.h

00001 //---------------------------------------------------------------------------
00002 
00003 #ifndef InterfaceH
00004 #define InterfaceH
00005 
00006 #include "Messages.h"
00007 
00008 /*//////////////////////////////////////////////////////////////////////////
00009  DoIntroduction()
00010  This will be called before anything else is done in a non-batch situation.
00011  It allows the interface to call any introductory screens, or ignore it if
00012  there's nothing to be done.
00014 void DoIntroduction();
00015 
00016 /*//////////////////////////////////////////////////////////////////////////
00017  GetMessage()
00018  This is used when the model is expecting a user message and cannot go on
00019  without one.  This function will continue to listen for input until some has
00020  been received.
00022 modelMsg GetMessage();
00023 
00024 /*//////////////////////////////////////////////////////////////////////////
00025  CheckForMessage()
00026  This is used when the model is checking for a message which may have come
00027  in during processing.  A return message of "no message" is acceptable if
00028  the user has not requested any actions.
00029 
00030  For now this assumes that any keys hit by the user mean "pause", but this
00031  idea should be expanded out if significant need for message-passing is
00032  discovered.
00034 modelMsg CheckForMessage(char *cAppPath);
00035 
00036 /*//////////////////////////////////////////////////////////////////////////
00037  SendMessage()
00038  This function accepts a message from the sim manager.
00040 void SendMessage(modelMsg msg, bool batch = false);
00041 
00042 /*//////////////////////////////////////////////////////////////////////////
00043  ExternalErrorHandler()
00044  This function accepts an error from the sim manager and processes it by
00045  displaying the appropriate error message.  If this is batch, different
00046  messages can be written.
00048 void ExternalErrorHandler(modelErr stcError, int iModelState, bool batch);
00049 //---------------------------------------------------------------------------
00050 #endif
00051 
00052 

Generated on Wed Nov 15 11:27:24 2006 for SORTIE C++ Test Documentation by  doxygen 1.4.7