Mobility.h

/************************************************************************************
* Copyright (C) 2023                                                               *
* TETCOS, Bangalore. India                                                         *
*                                                                                  *
* Tetcos owns the intellectual property rights in the Product and its content.     *
* The copying, redistribution, reselling or publication of any or all of the       *
* Product or its content without express prior written consent of Tetcos is        *
* prohibited. Ownership and / or any other right relating to the software and all *
* intellectual property rights therein shall remain at all times with Tetcos.      *
*                                                                                  *
* Author:    Shashi Kant Suman                                                       *
*                                                                                  *
* ---------------------------------------------------------------------------------*/
#include <Animation.h>
#ifndef _NETSIM_MOBILITY_H_
#define _NETSIM_MOBILITY_H_
#ifdef  __cplusplus
extern "C" {
#endif
 
#define Mobility_MODEL_DEFAULT                  _strdup("NO_MOBILITY")
#define Mobility_GROUP_ID_DEFAULT               1
#define Mobility_FILE_NAME_DEFAULT              _strdup("")
#define Mobility_OPEN_MOBILITY_FILE_DEFAULT     _strdup("")
#define Mobility_STEP_SIZE_DEFAULT              1
#define Mobility_CALCULATION_INTERVAL_DEFAULT   1
#define Mobility_MAX_SPEED_M_S_DEFAULT          3
#define Mobility_MIN_SPEED_M_S_DEFAULT          1
#define Mobility_STOP_PROBABILITY_DEFAULT       0.5
#define Mobility_STOP_DURATION_S_DEFAULT        5
 
    typedef enum enum_MobilityModel MOBILITY_MODEL;
 
    typedef struct stru_NetSim_Mobility NetSim_MOBILITY;
    typedef struct stru_NetSim_MobilityVar MOBILITY_VAR;
    /** Structure to store the mobility variables */
 
    typedef enum
    {
        MOVE_GROUP = PROTOCOL_MOBILITY * 100 + 1,
        NODE_JOIN,
        NODE_LEAVE,
    }MOBILTY_SUBEVNET;
    /* Enumeration for mobility model*/
    enum enum_MobilityModel
    {
        MobilityModel_NOMOBILITY,
        MobilityModel_RANDOMWAYPOINT,
        MobilityModel_RANDOMWALK,
        MobilityModel_FILEBASEDMOBILITY,
        MobilityModel_GROUP,
        MobilityModel_SUMO,
        MobilityModel_PEDESTRAIN,
    };
 
    //double dSimulationArea_X; //Store the simulation area_x
    //double dSimulationArea_Y;//Store the simulationar area_y
    double dOrigin_X; //Store the origin_x
    double dOrigin_Y; //Store the origin_y
    double dGridWidth; //Store the grid width
    double dGridLength; //Store the grid length
    double dGridMax_x; //Store the grid max_x
    double dGridMax_y; //Store the grid max_y
 
    /* Store the mobility variable for each device*/
    struct stru_NetSim_Mobility
    {
        double dAvgSpeed;           //Average speed of device
        MOBILITY_MODEL nMobilityType; //Mobility model
        void* pstruMobVar;          /*Pointer pointing to addition mobility model variables
                                 *That may be used by developer. This can be accessed by
                                 *DEVICE[]->Mobility->MobilityVar
                                 */
        struct stru_NetSim_Coordinates* pstruCurrentPosition; //Current position for device
        struct stru_NetSim_Coordinates* pstruNextPosition;     //Next position of device
    };
 
    struct stru_NetSim_MobilityVar
    {
        double dPauseTime; ///< To store the pause time.
        double dVelocity; ///< To store the velocity.
        unsigned long ulSeed1; ///< Used to generate random point.
        unsigned long ulSeed2; ///< Used to generate random point
        double dLastTime; ///< Represent the devices last move time.
        NETSIM_ID nGroupId; ///< To store group id of device.
        double dCalculationInterval;
        //Sumo
        char* sumoFileName;
        double step_size;
        //File-Based Mobility
        char* mobilityFileName;
        //Pedestrain
        double Max_Speed;
        double Min_Speed;
        double Stop_Probability;
        double Stop_Duration;
        double Pedestrain_Speed;
        double angel;
    };
 
    void add_mobility_animation(NETSIM_ID d,
        double t,
        double x,
        double y,
        double z);
    int FileBasedMobilityPointersFree();
    int fn_NMo_RandomPoint(double* X, double* Y, double velocity, double interval, unsigned long* pulSeed1, unsigned long* pulSeed2);
    int fn_NetSim_MoveGroup();
    int fn_NetSim_Mobility_Group_init();
    int add_to_group(NETSIM_ID group_id, NETSIM_ID dev_id);
    void mobility_pass_position_to_animation(NETSIM_ID devId, double time, NetSim_COORDINATES* coor);
    void log_mobility(MOVENODE log);
    void init_mobility_log();
    void close_mobility_logs();
    bool get_protocol_log_status(char* logname);
 
    // Sumo Interface
    double* corr(char* id);
    void pipes_init();
    void init_sumo();
    void sumo_run();
 
    //File based mobility
    int FileBasedMobilityReadingFile();
    void process_filebased_mobility_event();
    int FileBasedMobilityPointersFree();
 
    //Office
    void fn_NetSim_MObility_configureOffice(void* xmlNetSimNode);
 
#ifdef  __cplusplus
}
#endif
#endif