#ifndef SIMULATORX
#define SIMULATORX

#include "StandardConstants.h"
#include "configops.h"
#include "metadataops.h"

// data structures

typedef enum{
             PROCESS_STATE_NEW = 0, 
             PROCESS_STATE_READY, 
             PROCESS_STATE_RUNNING, 
             PROCESS_STATE_BLOCKED, 
             PROCESS_STATE_TERMINATED
            } PROCESS_STATES;

typedef struct ProcessControlBlockStruct
{
    int uniquePid;
    PROCESS_STATES process_state;
    //
} ProcessControlBlock;

/*
Name: ???
Process: ???
Function Input/Parameters: ???
Function Output/Parameters: none
Function Output/Returned: none
Device Input/Device: none
Device Output/Device: none
Dependencies: ???
*/
// need a function (or functions) to handle FILE I/O?

/*
Name: ???
Process: ???
// Function Input/Parameters: ???
Function Output/Parameters: none
Function Output/Returned: none
Device Input/Device: none
Device Output/Device: none
Dependencies: ???
*/
// need a function to ???

/*
Name: runSim
Process: primary simulation driver
Function Input/Parameters: configuration data (ConfigDataType *),
                           metadata (OpCodeType *)
Function Output/Parameters: none
Function Output/Returned: none
Device Input/Device: none
Device Output/Device: none
Dependencies: ???
*/
void runSim(ConfigDataType *configPtr, OpCodeType *metaDataMstrPtr);

#endif // SIMULATORX