GetScenario.h

Go to the documentation of this file.

/* © 1998 JRM Technologies, Inc.*/

#ifndef _GETSCENARIO_H_
#define _GETSCENARIO_H_

#include "JRMlibrary.h"
#include "Ellipsoid.h"
#include "sigsim.h"
#include "Objects.h"
#include "sigsimOGL.h"


#ifdef __cplusplus
extern "C"
{
#endif
   /* 
    * int GetScenario
    * 
    * Reads a SigSim scenario file and returns parameters read from the file
    *
    * Returns SIGSIM_SUCCESS on success
    *
    * Parameters
    * 
    * char *sigsim_data_dir          : The SIGSIM data directory, may by NULL
    * char *scenariofile             : The scenario file to read, must be valid
    * char *matlfile                 : The material system file, may be NULL
    * char *mmlsfile            : The man-made light source file, may be NULL, defaults to atm/mm_lsources.dat
    * OBJECT *object                 : The object of interest, may be NULL
    * char *night_sky_file           : The file for specifying the default extraterrestrial sources, may be NULL
    * double *tod                    : The initial time of day (0-24) [hrs], may be NULL
    * double *max_tod                : The maximum time of day for the scenario (0-24) [hrs], may be NULL, 
    * double *time_step              : The time step used in calculations [hrs], may be NULL, 
    * METIN *metin                   : The MET data, must be valid
    * int *nsensors                  : The number of sensors, may be NULL
    * SENSOR **sens                  : The sensors, may be NULL
    * LIGHT_SOURCE_TABLE **ls_table, : The light sources, may be NULL);
    */
    SIGSIM_API int GetScenario(char *sigsim_data_dir, char *scenariofile, char *matlfile, OBJECT *object, char *mmlsfile, char *night_sky_file, double *tod, double *max_tod, double *time_step, METIN *metin, int *nsensors, SENSOR **sens, LIGHT_SOURCE_TABLE **ls_table);
    SIGSIM_API int ReadScenarioFile(char *sigsim_data_dir, char *file, char *matlfile, OBJECT *object, char *mmlsfile, char *night_sky_file, double *tod, double *max_tod, double *time_step, METIN *metin, int *nsensors, SENSOR **sens); // Called by GetScenario(),
    SIGSIM_API int WriteScenarioFile(char *sigsim_data_dir, const char *file, jrmbool NEWorOLD, char *matlfile, OBJECT *object, char *mmlsfile, char *night_sky_file, double max_tod, double time_step, METIN *metin, int nsensors, SENSOR *sens);

#ifdef _POLYGONS_H_
    SIGSIM_API int AllocateTestObject(OBJECT *object);
#endif

/* ----------------- SCENARIOS with MOTION --------------------- */

    typedef struct
    {
      char sigsim_scenariofile[SIGSIM_STRING_SIZE];         // SigSim scenario file to use (OPTIONAL for sonar)
        char target_filelist[SIGSIM_STRING_SIZE];               // Target Strength File List to use (contains names of target files on disk)
        char seadata_file[SIGSIM_STRING_SIZE];                  // SUBSURFACE_1DPROFILE sea data file to use
      char datalink_file[SIGSIM_STRING_SIZE];               // DATALINK_PARTICIPANT data file
      char rfjammer_file[SIGSIM_STRING_SIZE];               // RF_JAMMER data file
        char source_ID[SIGSIM_STRING_SIZE];                     // Unique source/sensor identifier (required).
      char sdatalink_ID[SIGSIM_STRING_SIZE];             // Sensor datalink to use (if any).
        char contact_ID[SIGSIM_STRING_SIZE];                    // Target unique identifier (required).
      char tdatalink_ID[SIGSIM_STRING_SIZE];             // Target datalink to use (if any).
      char rfjammer_ID[SIGSIM_STRING_SIZE];              // Target RF jammer to use (if any).
        ST_PLACEMENT *plc;                                      // Sensor-Target placement array to loop through
        int nplc;                                               // Number of placement pairs.
    }   TEST_SCENARIO;                                // Test Scenario

    SIGSIM_API int LoadTestScenario(char *file, TEST_SCENARIO *st);
    SIGSIM_API void FreeTestScenario(TEST_SCENARIO *st, jrmbool init);



#ifdef __cplusplus
}
#endif

#endif // _GETSCENARIO_H_