LibItsGeoNetworking_Functions.ttcn 113 KB
Newer Older
garciay's avatar
garciay committed
/**
 *  @author     ETSI / STF405 / STF449 / STF484 / STF517
 *  @version    $Url: https://oldforge.etsi.org/svn/LibIts/tags/20170222_STF527_Final/ttcn/GeoNetworking/LibItsGeoNetworking_Functions.ttcn $
 *              $Id: LibItsGeoNetworking_Functions.ttcn 1329 2017-02-21 14:48:18Z berge $
 *  @desc       Module containing functions for GeoNetworking
 *  @copyright   ETSI Copyright Notification
 *               No part may be reproduced except as authorized by written permission.
 *               The copyright and the foregoing restriction extend to reproduction in all media.
 *               All rights reserved.
 *
 */
module LibItsGeoNetworking_Functions {
    
  // Libcommon
  import from LibCommon_BasicTypesAndValues all;
  import from LibCommon_DataStrings all;
  import from LibCommon_VerdictControl all;
  import from LibCommon_Sync all;
  import from LibCommon_Time all;
    
  // LibIts
  import from IEEE1609dot2BaseTypes language "ASN.1:1997" all;
  import from IEEE1609dot2 language "ASN.1:1997" all;
  import from EtsiTs103097Module language "ASN.1:1997" all;
    
  // LibItsCommon
  import from LibItsCommon_TypesAndValues all;
  import from LibItsExternal_TypesAndValues all;
  import from LibItsCommon_Templates all;
  import from LibItsCommon_Functions all;
  import from LibItsCommon_Pixits all;
  //    import from LibItsCommon_TestSystem all;
    
  // LibItsSecurity
  import from LibItsSecurity_TypesAndValues all;
  import from LibItsSecurity_Templates all;
  import from LibItsSecurity_Functions all;
  import from LibItsSecurity_Pixits all;
    
  // LibItsGeoNetworking
  import from LibItsGeoNetworking_TestSystem all;
  import from LibItsGeoNetworking_TypesAndValues all;
  import from LibItsGeoNetworking_Templates all;
  import from LibItsGeoNetworking_Pixits all;
  import from LibItsGeoNetworking_Pics all;
    
  group utFuntions {
        
    /**
     * @desc    Requests to bring the IUT in an initial state
     * @param   p_init The initialisation to trigger.
     */
    function f_utInitializeIut(template (value) UtGnInitialize p_init) runs on ItsBaseGeoNetworking {
            
      //deactivate gnPort default alts
    vc_gnDefaultActive := false;
            
      utPort.send(p_init);
      tc_wait.start;
      alt {
	      [] utPort.receive(UtGnResults: { utGnInitializeResult := true }) {
          tc_wait.stop;
          log("*** f_utInitializeIut: INFO: IUT initialized ***");
        }
        [] utPort.receive {
          tc_wait.stop;
          log("*** f_utInitializeIut: INFO: IUT could not be initialized ***");
          f_selfOrClientSyncAndVerdict("error", e_error);
        }
        [] tc_wait.timeout {
          log("*** f_utInitializeIut: INFO: IUT could not be initialized in time ***");
          f_selfOrClientSyncAndVerdict("error", e_timeout);
        }
      }
            
      //activate gnPort default alts
    vc_gnDefaultActive := true;
            
    }
        
    /**
     * @desc    Requests to change the position of the IUT
     */
    function f_utChangePosition() runs on ItsBaseGeoNetworking {
            
      //deactivate gnPort default alts
    vc_gnDefaultActive := false;
            
      utPort.send(m_changePosition);
      tc_wait.start;
      alt {
	      [] utPort.receive(UtGnResults: { utGnChangePositionResult := true} ) {
          tc_wait.stop;
          log("*** f_utChangePosition: INFO: IUT position changed ***");
        }
        [] utPort.receive(UtGnResults: { utGnChangePositionResult := false }) {
          tc_wait.stop;
          log("*** f_utChangePosition: INFO: IUT position change was not successful ***");
          f_selfOrClientSyncAndVerdict("error", e_error);
        }
        [] a_utDefault() {
        }
        [] tc_wait.timeout {
          log("*** f_utChangePosition: INFO: IUT position not changed in time ***");
          f_selfOrClientSyncAndVerdict("error", e_timeout);
        }
      }
            
      //activate gnPort default alts
    vc_gnDefaultActive := true;
            
    }
        
    /**
     * @desc    Triggers event from the application layer
     * @param   p_event The event to trigger.
     */
    function f_utTriggerEvent(template (value) UtGnTrigger p_event) runs on ItsBaseGeoNetworking return boolean {
            
      // Variables
      var boolean v_return := true;

      //deactivate gnPort default alts
    vc_gnDefaultActive := false;
            
      utPort.send(p_event);
      tc_wait.start;
      alt {
	      [] utPort.receive(UtGnResults: { utGnTriggerResult := true }) {
          tc_wait.stop;
	      }
	      [] utPort.receive(UtGnResults: { utGnTriggerResult := false }) {
          tc_wait.stop;
          log("*** UtGnTriggerResult: INFO: UT trigger was not successful ***");
          f_selfOrClientSyncAndVerdict("error", e_error);
        }
        [] a_utDefault() {
        }
        [] tc_wait.timeout {
        v_return := false;
        }
      }
            
      //activate gnPort default alts
    vc_gnDefaultActive := true;
            
      return v_return;
    }
        
  } // End of group utFunctions
    
  group geoConfigurationFunctions {
        
    /**
     * @desc This configuration features:
     *       - one ITS node (IUT)
     *       - two ITS nodes (nodeA, nodeB)
     *       - Area1 which only includes NodeB and IUT
     *       - Area2 which only includes NodeB
     *         NodeB being close to the area center
     */
    function f_cf01Up(Scenario p_scenario := e_staticPosition) runs on ItsGeoNetworking system ItsGeoNetworkingSystem {
            
      // Variables
      var PositionTable v_positionTable := {};
      var GeoAreaTable v_areaTable := {};
            
      // Map
      map(self:acPort, system:acPort);
      map(self:utPort, system:utPort);
      map(self:geoNetworkingPort, system:geoNetworkingPort);
            
      // Connect
      f_connect4SelfOrClientSync();
      activate(a_cf01Down());
            
      // Initialise secured mode
      f_initialiseSecuredMode();
            
      //Initialze the IUT
      f_initialState(p_scenario);
            
      // Positions & Areas
      f_preparePositionsAndAreas(v_positionTable, v_areaTable);
            
      f_initialiseComponent(v_positionTable, v_areaTable, c_compNodeB);
            
    } // End of group f_cf01Up
garciay's avatar
garciay committed
        
    function f_cf01Down() runs on ItsGeoNetworking system ItsGeoNetworkingSystem {
            
      f_uninitialiseSecuredMode();
            
      // Unmap
      unmap(self:acPort, system:acPort);
      unmap(self:utPort, system:utPort);
      unmap(self:geoNetworkingPort, system:geoNetworkingPort);
            
      // Disconnect
      f_disconnect4SelfOrClientSync();
            
        } // End of function f_cf01Down
garciay's avatar
garciay committed
        
    /**
     * @desc This configuration features:
     *       - one ITS node (IUT)
     *       - one ITS node (NodeB)
     *       - one ITS node (NodeD)
     *       - Area1 which only includes NodeB, NodeD and IUT
     *       - Area2 which only includes NodeB and NodeD
     *         NodeB being close to the area center
     *
     * @param p_mainUtComponent Name of the component that will initialize IUT and handle default UT messages
     */
    function f_cf02Up(in charstring p_mainUtComponent := c_compMTC, Scenario p_scenario := e_staticPosition) runs on ItsMtc mtc ItsMtc system ItsGeoNetworkingSystem {
            
      // Variables
      var PositionTable v_positionTable := {};
      var GeoAreaTable v_areaTable := {};
      var ItsGeoNetworking v_component;
      var integer i;
            
      // Select components
      vc_componentTable := {{c_compNodeB, omit}, {c_compNodeD, omit}};
            
      // Create components
      for(i:=0; i < lengthof(vc_componentTable); i:=i+1) {
        vc_componentTable[i].gnComponent := ItsGeoNetworking.create(vc_componentTable[i].componentName) alive;
      }
            
      // Map & Connect
      map(self:acPort, system:acPort);
      map(self:utPort, system:utPort);
      connect(self:syncPort, mtc:syncPort);
      for(i:=0; i < lengthof(vc_componentTable); i:=i+1) {
        map(vc_componentTable[i].gnComponent:acPort, system:acPort);
        map(vc_componentTable[i].gnComponent:utPort, system:utPort);
        map(vc_componentTable[i].gnComponent:geoNetworkingPort, system:geoNetworkingPort);
        connect(vc_componentTable[i].gnComponent:syncPort, self:syncPort);
      }
            
      activate(a_cf02Down());
            
      //Initialze the IUT
      if(p_mainUtComponent == c_compMTC) {
        // Initialise secured mode
        f_initialiseSecuredMode();
                
        // MTC intializes IUT
        f_initialState(p_scenario);
      }
      else {
      v_component := f_getComponent(p_mainUtComponent);
        v_component.start(f_initialState(p_scenario));
        v_component.done;
      }
      
      // Positions & Areas
            f_preparePositionsAndAreas(v_positionTable, v_areaTable);
      
      // Initialize components
      for(i:=0; i < lengthof(vc_componentTable); i:=i+1) {
        if (isvalue(vc_componentTable[i].gnComponent)) {
          vc_componentTable[i].gnComponent.start(f_initialiseComponent(v_positionTable, v_areaTable, vc_componentTable[i].componentName));
        }
      }
      for(i:=0; i < lengthof(vc_componentTable); i:=i+1) {
        if (isvalue(vc_componentTable[i].gnComponent)) {
          vc_componentTable[i].gnComponent.done;
        }
      }
            
        } // End of group f_cf02Up
garciay's avatar
garciay committed
        
    /**
     * @desc Deletes configuration cf02
     */
    function f_cf02Down() runs on ItsMtc mtc ItsMtc system ItsGeoNetworkingSystem {
            
      // Local variables
      var integer i;
            
      f_uninitialiseSecuredMode();
            
      // Unmap & Disconnect
      for(i:=0; i < lengthof(vc_componentTable); i:=i+1) { 
        unmap(vc_componentTable[i].gnComponent:utPort, system:utPort);
        unmap(vc_componentTable[i].gnComponent:acPort, system:acPort);
        unmap(vc_componentTable[i].gnComponent:geoNetworkingPort, system:geoNetworkingPort);
        disconnect(vc_componentTable[i].gnComponent:syncPort, self:syncPort);
      }
      unmap(self:acPort, system:acPort);
      unmap(self:utPort, system:utPort);
      disconnect(self:syncPort, mtc:syncPort);
            
        } // End of group f_cf02Down
garciay's avatar
garciay committed
        
    /**
     * @desc This configuration features:
     *       - one ITS node (IUT)
     *       - one ITS node (NodeA)
     *       - one ITS node in direction of NodeA (NodeB)
     *       - one ITS node not in direction of NodeA (NodeC)
     *       - Area1 which only includes NodeB and IUT
     *       - Area2 which only includes NodeB
     *         NodeB being close to the area center
     * @param p_mainUtComponent Name of the component that will initialize IUT and handle default UT messages
     */
    function f_cf03Up(in charstring p_mainUtComponent := c_compMTC, Scenario p_scenario := e_staticPosition) runs on ItsMtc mtc ItsMtc system ItsGeoNetworkingSystem {
            
      // Variables
      var PositionTable v_positionTable := {};
      var GeoAreaTable v_areaTable := {};
      var ItsGeoNetworking v_component;
      var integer i;
            
      // Select components
    vc_componentTable := {{c_compNodeB, omit}, {c_compNodeC, omit}};
            
      // Create components
      for(i:=0; i < lengthof(vc_componentTable); i:=i+1) {
        vc_componentTable[i].gnComponent := ItsGeoNetworking.create(vc_componentTable[i].componentName) alive;
      }
            
      // Map & Connect
      map(self:acPort, system:acPort);
      map(self:utPort, system:utPort);
      connect(self:syncPort, mtc:syncPort);
      for(i:=0; i < lengthof(vc_componentTable); i:=i+1) {
        map(vc_componentTable[i].gnComponent:acPort, system:acPort);
        map(vc_componentTable[i].gnComponent:utPort, system:utPort);
        map(vc_componentTable[i].gnComponent:geoNetworkingPort, system:geoNetworkingPort);
        connect(vc_componentTable[i].gnComponent:syncPort, self:syncPort);
      }
            
      activate(a_cf03Down());
            
      //Initialze the IUT
      if(p_mainUtComponent == c_compMTC) {
        // Initialise secured mode
        f_initialiseSecuredMode();
                
        // MTC intializes IUT
        f_initialState(p_scenario);
      }
      else {
      v_component := f_getComponent(p_mainUtComponent);
        v_component.start(f_initialState(p_scenario));
        v_component.done;   
      }
            
      // Positions & Areas
            f_preparePositionsAndAreas(v_positionTable, v_areaTable);
            
      // Initialize components
      for(i:=0; i < lengthof(vc_componentTable); i:=i+1) {
        if (isvalue(vc_componentTable[i].gnComponent)) {
          vc_componentTable[i].gnComponent.start(f_initialiseComponent(v_positionTable, v_areaTable, vc_componentTable[i].componentName));
        }
      }
      for(i:=0; i < lengthof(vc_componentTable); i:=i+1) {
        if (isvalue(vc_componentTable[i].gnComponent)) {
          vc_componentTable[i].gnComponent.done;
        }
      }
            
    } // End of group f_cf03Up
garciay's avatar
garciay committed
        
    /**
     * @desc Deletes configuration cf03
     */
    function f_cf03Down() runs on ItsMtc mtc ItsMtc system ItsGeoNetworkingSystem {
            
      // Local variables
      var integer i;
            
      f_uninitialiseSecuredMode();
            
      // Unmap & Disconnect
      for(i:=0; i < lengthof(vc_componentTable); i:=i+1) { 
        unmap(vc_componentTable[i].gnComponent:utPort, system:utPort);
        unmap(vc_componentTable[i].gnComponent:acPort, system:acPort);
        unmap(vc_componentTable[i].gnComponent:geoNetworkingPort, system:geoNetworkingPort);
        disconnect(vc_componentTable[i].gnComponent:syncPort, self:syncPort);
      }
      unmap(self:acPort, system:acPort);
      unmap(self:utPort, system:utPort);
      disconnect(self:syncPort, mtc:syncPort);
        
    } // End of group f_cf03Down
garciay's avatar
garciay committed
        
    /**
     * @desc This configuration features:
     *       - one ITS node (IUT)
     *       - one ITS node (NodeA)
     *       - one ITS node in direction of NodeA and having
     *         shortest distance to NodeA (NodeB)
     *       - one ITS node in direction of NodeA (NodeD)
     *       - one ITS node not in direction of NodeA (NodeC)
     *       - Area1 which only includes NodeB, NodeD and IUT
     *       - Area2 which only includes NodeA, NodeB and NodeD
     *         NodeB being close to the area center
     * @param p_mainUtComponent Name of the component that will initialize IUT and handle default UT messages
     */
    function f_cf04Up(in charstring p_mainUtComponent := c_compMTC, Scenario p_scenario := e_staticPosition) runs on ItsMtc mtc ItsMtc system ItsGeoNetworkingSystem {
            
      // Variables
      var PositionTable v_positionTable := {};
      var GeoAreaTable v_areaTable := {};
      var ItsGeoNetworking v_component;
      var integer i;
            
      // Select components
    vc_componentTable := {{c_compNodeB, omit}, {c_compNodeC, omit}, {c_compNodeD, omit}};
            
      // Create components
      for(i:=0; i < lengthof(vc_componentTable); i:=i+1) {
        vc_componentTable[i].gnComponent := ItsGeoNetworking.create(vc_componentTable[i].componentName) alive;
      }
            
      // Map & Connect
      map(self:acPort, system:acPort);
      map(self:utPort, system:utPort);
      connect(self:syncPort, mtc:syncPort);
      for(i:=0; i < lengthof(vc_componentTable); i:=i+1) {
        map(vc_componentTable[i].gnComponent:acPort, system:acPort);
        map(vc_componentTable[i].gnComponent:utPort, system:utPort);
        map(vc_componentTable[i].gnComponent:geoNetworkingPort, system:geoNetworkingPort);
        connect(vc_componentTable[i].gnComponent:syncPort, self:syncPort);
      }
            
      activate(a_cf04Down());
            
      //Initialze the IUT
      if(p_mainUtComponent == c_compMTC) {
        // Initialise secured mode
        f_initialiseSecuredMode();
                
        // MTC intializes IUT
        f_initialState(p_scenario);
      }
      else {
      v_component := f_getComponent(p_mainUtComponent);
        v_component.start(f_initialState(p_scenario));
        v_component.done;   
      }
            
      // Positions & Areas
            f_preparePositionsAndAreas(v_positionTable, v_areaTable);
            
      // Initialize components
      for(i:=0; i < lengthof(vc_componentTable); i:=i+1) {
        if (isvalue(vc_componentTable[i].gnComponent)) {
          vc_componentTable[i].gnComponent.start(f_initialiseComponent(v_positionTable, v_areaTable, vc_componentTable[i].componentName));
        }
      }
      for(i:=0; i < lengthof(vc_componentTable); i:=i+1) {
        if (isvalue(vc_componentTable[i].gnComponent)) {
          vc_componentTable[i].gnComponent.done;
        }
      }
            
    } // End of group f_cf04Up
garciay's avatar
garciay committed
        
    /**
     * @desc Deletes configuration cf04
     */
    function f_cf04Down() runs on ItsMtc mtc ItsMtc system ItsGeoNetworkingSystem {
            
      // Local variables
      var integer i;
            
      f_uninitialiseSecuredMode();
            
      // Unmap & Disconnect
      for(i:=0; i < lengthof(vc_componentTable); i:=i+1) { 
        unmap(vc_componentTable[i].gnComponent:utPort, system:utPort);
        unmap(vc_componentTable[i].gnComponent:acPort, system:acPort);
        unmap(vc_componentTable[i].gnComponent:geoNetworkingPort, system:geoNetworkingPort);
        disconnect(vc_componentTable[i].gnComponent:syncPort, self:syncPort);
      }
      unmap(self:acPort, system:acPort);
      unmap(self:utPort, system:utPort);
      disconnect(self:syncPort, mtc:syncPort);
            
    } // End of group f_cf04Down
garciay's avatar
garciay committed

    /**
     * @desc This configuration features:
     *       - one ITS node (IUT)
     *       - one ITS node (NodeB)
     *       - one ITS node not in direction of NodeB and having
     *         longest distance to NodeB (NodeE)
     *       - Area1 which only includes NodeB, NodeD and IUT
     * @param p_mainUtComponent Name of the component that will initialize IUT and handle default UT messages
     */
    function f_cf05Up(in charstring p_mainUtComponent := c_compMTC, Scenario p_scenario := e_staticPosition) runs on ItsMtc mtc ItsMtc system ItsGeoNetworkingSystem {
            
      // Variables
      var PositionTable v_positionTable := {};
      var GeoAreaTable v_areaTable := {};
      var ItsGeoNetworking v_component;
      var integer i;
            
      // Select components
    vc_componentTable := {{c_compNodeB, omit}, {c_compNodeE, omit}};
            
      // Create components
      for(i:=0; i < lengthof(vc_componentTable); i:=i+1) {
        vc_componentTable[i].gnComponent := ItsGeoNetworking.create(vc_componentTable[i].componentName) alive;
      }
            
      // Map & Connect
      map(self:acPort, system:acPort);
      map(self:utPort, system:utPort);
      connect(self:syncPort, mtc:syncPort);
      for(i:=0; i < lengthof(vc_componentTable); i:=i+1) {
        map(vc_componentTable[i].gnComponent:acPort, system:acPort);
        map(vc_componentTable[i].gnComponent:utPort, system:utPort);
        map(vc_componentTable[i].gnComponent:geoNetworkingPort, system:geoNetworkingPort);
        connect(vc_componentTable[i].gnComponent:syncPort, self:syncPort);
      }
            
      activate(a_cf05Down());
            
      //Initialze the IUT
      if(p_mainUtComponent == c_compMTC) {
        // Initialise secured mode
        f_initialiseSecuredMode();
                
        // MTC intializes IUT
        f_initialState(p_scenario);
      }
      else {
      v_component := f_getComponent(p_mainUtComponent);
        v_component.start(f_initialState(p_scenario));
        v_component.done;   
      }
            
      // Positions & Areas
            f_preparePositionsAndAreas(v_positionTable, v_areaTable);
            
      // Initialize components
      for(i:=0; i < lengthof(vc_componentTable); i:=i+1) {
        if (isvalue(vc_componentTable[i].gnComponent)) {
          vc_componentTable[i].gnComponent.start(f_initialiseComponent(v_positionTable, v_areaTable, vc_componentTable[i].componentName));
        }
      }
      for(i:=0; i < lengthof(vc_componentTable); i:=i+1) {
        if (isvalue(vc_componentTable[i].gnComponent)) {
          vc_componentTable[i].gnComponent.done;
        }
      }
    }
        
    /**
     * @desc Deletes configuration cf05
     */
    function f_cf05Down() runs on ItsMtc mtc ItsMtc system ItsGeoNetworkingSystem {
            
      // Local variables
      var integer i;
            
      f_uninitialiseSecuredMode();
            
      // Unmap & Disconnect
      for(i:=0; i < lengthof(vc_componentTable); i:=i+1) { 
        unmap(vc_componentTable[i].gnComponent:utPort, system:utPort);
        unmap(vc_componentTable[i].gnComponent:acPort, system:acPort);
        unmap(vc_componentTable[i].gnComponent:geoNetworkingPort, system:geoNetworkingPort);
        disconnect(vc_componentTable[i].gnComponent:syncPort, self:syncPort);
      }
      unmap(self:acPort, system:acPort);
      unmap(self:utPort, system:utPort);
      disconnect(self:syncPort, mtc:syncPort);
            
    } // End of group f_cf05Down
garciay's avatar
garciay committed
        
    /**
     * @desc This configuration features:
     *       - one ITS node (IUT)
     *       - one ITS node (NodeB)
     *       - one ITS node not in direction of NodeB and having
     *         shortest distance to NodeB (NodeF)
     *       - Area1 which only includes NodeB, NodeD and IUT
     *       - IUT not in sectorial area of NodeB-NodeF
     * @param p_mainUtComponent Name of the component that will initialize IUT and handle default UT messages
     */
    function f_cf06Up(in charstring p_mainUtComponent := c_compMTC, Scenario p_scenario := e_staticPosition) runs on ItsMtc mtc ItsMtc system ItsGeoNetworkingSystem {
                    
      // Variables
      var PositionTable v_positionTable := {};
      var GeoAreaTable v_areaTable := {};
      var ItsGeoNetworking v_component;
      var integer i;
            
      // Select components
    vc_componentTable := {{c_compNodeB, omit}, {c_compNodeF, omit}};
            
      // Create components
      for(i:=0; i < lengthof(vc_componentTable); i:=i+1) {
        vc_componentTable[i].gnComponent := ItsGeoNetworking.create(vc_componentTable[i].componentName) alive;
      }
            
      // Map & Connect
      map(self:acPort, system:acPort);
      map(self:utPort, system:utPort);
      connect(self:syncPort, mtc:syncPort);
      for(i:=0; i < lengthof(vc_componentTable); i:=i+1) {
        map(vc_componentTable[i].gnComponent:acPort, system:acPort);
        map(vc_componentTable[i].gnComponent:utPort, system:utPort);
        map(vc_componentTable[i].gnComponent:geoNetworkingPort, system:geoNetworkingPort);
        connect(vc_componentTable[i].gnComponent:syncPort, self:syncPort);
      }
            
      activate(a_cf06Down());
            
      //Initialze the IUT
      if(p_mainUtComponent == c_compMTC) {
        // Initialise secured mode
        f_initialiseSecuredMode();
                
        // MTC intializes IUT
        f_initialState(p_scenario);
      }
      else {
      v_component := f_getComponent(p_mainUtComponent);
        v_component.start(f_initialState(p_scenario));
        v_component.done;   
      }
            
      // Positions & Areas
            f_preparePositionsAndAreas(v_positionTable, v_areaTable);
            
      // Initialize components
      for(i:=0; i < lengthof(vc_componentTable); i:=i+1) {
        if (isvalue(vc_componentTable[i].gnComponent)) {
          vc_componentTable[i].gnComponent.start(f_initialiseComponent(v_positionTable, v_areaTable, vc_componentTable[i].componentName));
        }
      }
      for(i:=0; i < lengthof(vc_componentTable); i:=i+1) {
        if (isvalue(vc_componentTable[i].gnComponent)) {
          vc_componentTable[i].gnComponent.done;
        }
      }
    }
        
    /**
     * @desc Deletes configuration cf06
     */
    function f_cf06Down() runs on ItsMtc mtc ItsMtc system ItsGeoNetworkingSystem {
            
      // Local variables
      var integer i;
            
      f_uninitialiseSecuredMode();
            
      // Unmap & Disconnect
      for(i:=0; i < lengthof(vc_componentTable); i:=i+1) { 
        unmap(vc_componentTable[i].gnComponent:utPort, system:utPort);
        unmap(vc_componentTable[i].gnComponent:acPort, system:acPort);
        unmap(vc_componentTable[i].gnComponent:geoNetworkingPort, system:geoNetworkingPort);
        disconnect(vc_componentTable[i].gnComponent:syncPort, self:syncPort);
      }
      unmap(self:acPort, system:acPort);
      unmap(self:utPort, system:utPort);
      disconnect(self:syncPort, mtc:syncPort);
            
    } // End of group f_cf06Down
garciay's avatar
garciay committed

    /**
     * @desc This configuration features:
     *       - one ITS node (IUT)
     *       - one ITS node (NodeB)
     *       - one ITS node in direction of NodeB and having
     *         shortest distance to NodeB (NodeD)
     *       - Area1 which only includes NodeB, NodeD and IUT
     * @param p_mainUtComponent Name of the component that will initialize IUT and handle default UT messages
     */
    function f_cf07Up(in charstring p_mainUtComponent := c_compMTC, Scenario p_scenario := e_staticPosition) runs on ItsMtc mtc ItsMtc system ItsGeoNetworkingSystem {
                    
      // Variables
      var PositionTable v_positionTable := {};
      var GeoAreaTable v_areaTable := {};
      var ItsGeoNetworking v_component;
      var integer i;
            
      // Select components
    vc_componentTable := {{c_compNodeB, omit}, {c_compNodeD, omit}};
            
      // Create components
      for(i:=0; i < lengthof(vc_componentTable); i:=i+1) {
        vc_componentTable[i].gnComponent := ItsGeoNetworking.create(vc_componentTable[i].componentName) alive;
      }
            
      // Map & Connect
      map(self:acPort, system:acPort);
      map(self:utPort, system:utPort);
      connect(self:syncPort, mtc:syncPort);
      for(i:=0; i < lengthof(vc_componentTable); i:=i+1) {
        map(vc_componentTable[i].gnComponent:acPort, system:acPort);
        map(vc_componentTable[i].gnComponent:utPort, system:utPort);
        map(vc_componentTable[i].gnComponent:geoNetworkingPort, system:geoNetworkingPort);
        connect(vc_componentTable[i].gnComponent:syncPort, self:syncPort);
      }
            
      activate(a_cf07Down());
            
      //Initialze the IUT
      if(p_mainUtComponent == c_compMTC) {
        // Initialise secured mode
        f_initialiseSecuredMode();
                
        // MTC intializes IUT
        f_initialState(p_scenario);
      }
      else {
      v_component := f_getComponent(p_mainUtComponent);
        v_component.start(f_initialState(p_scenario));
        v_component.done;   
      }
            
      // Positions & Areas
            f_preparePositionsAndAreas(v_positionTable, v_areaTable);
            
      // Initialize components
      for(i:=0; i < lengthof(vc_componentTable); i:=i+1) {
        if (isvalue(vc_componentTable[i].gnComponent)) {
          vc_componentTable[i].gnComponent.start(f_initialiseComponent(v_positionTable, v_areaTable, vc_componentTable[i].componentName));
        }
      }
      for(i:=0; i < lengthof(vc_componentTable); i:=i+1) {
        if (isvalue(vc_componentTable[i].gnComponent)) {
          vc_componentTable[i].gnComponent.done;
        }
      }
    }
        
    /**
     * @desc Deletes configuration cf06
     */
    function f_cf07Down() runs on ItsMtc mtc ItsMtc system ItsGeoNetworkingSystem {
            
      // Local variables
      var integer i;
            
      f_uninitialiseSecuredMode();
            
      // Unmap & Disconnect
      for(i:=0; i < lengthof(vc_componentTable); i:=i+1) { 
        unmap(vc_componentTable[i].gnComponent:utPort, system:utPort);
        unmap(vc_componentTable[i].gnComponent:acPort, system:acPort);
        unmap(vc_componentTable[i].gnComponent:geoNetworkingPort, system:geoNetworkingPort);
        disconnect(vc_componentTable[i].gnComponent:syncPort, self:syncPort);
      }
      unmap(self:acPort, system:acPort);
      unmap(self:utPort, system:utPort);
      disconnect(self:syncPort, mtc:syncPort);
            
    } // End of group f_cf07Down
garciay's avatar
garciay committed
        
    /**
     * @desc    Behavior function for initializing component's variables and tables
     * @param   p_positionTable Table containing position vectors of all nodes
     * @param   p_areaTable     Table containing all defined geoAreas
     * @param   p_componentName Name of the component
     */
    function f_initialiseComponent(
                                   in PositionTable p_positionTable,
                                   in GeoAreaTable p_areaTable,
                                   in charstring p_componentName)
    runs on ItsGeoNetworking {
            
    vc_positionTable := p_positionTable;
    vc_areaTable := p_areaTable;
    vc_componentName := p_componentName;
            
    vc_localSeqNumber := f_getInitialSequenceNumber();
    vc_multipleMessagesCount := f_getMessageCount();
            
        } // End of function f_initialiseComponent
garciay's avatar
garciay committed
        
    /**
     * @desc    Makes the simulated ITS node behave as a neighbour of IUT
     */
    function f_startBeingNeighbour() runs on ItsGeoNetworking {
            
      vc_neighbourDefault := activate(a_neighbourDefault());
      f_acTriggerEvent(m_startBeaconing(m_beaconHeader(f_getPosition(vc_componentName)).beaconHeader));
      f_sleepIgnoreDef(PX_NEIGHBOUR_DISCOVERY_DELAY);
        } // End of function f_startBeingNeighbour
garciay's avatar
garciay committed
        
    /**
     * @desc    Makes the simulated ITS node behave as not being a neighbour of IUT
     */
    function f_stopBeingNeighbour() runs on ItsGeoNetworking {
            
      f_acTriggerEvent(m_stopBeaconing);
      if (PICS_GN_SECURITY == true) {
        deactivate(vc_neighbourDefault);
      }
        } // End of function f_stopBeingNeighbour
garciay's avatar
garciay committed
        
    /**
     * @desc Initialise secure mode if required
     */
    function f_initialiseSecuredMode() runs on ItsBaseGeoNetworking {
      
      // Local variables
      
      // Load certificates
      if (PICS_GN_SECURITY == true) {
        if( not f_loadCertificates(PX_IUT_SEC_CONFIG_NAME) ) {
          log("*** INFO: TEST CASE NOW STOPPING ITSELF! ***");
          stop;
        }
        
        // Initialize vc_location
        f_setGenerationLocation(
                                f_getTsLatitude(),
                                f_getTsLongitude()
                                );
      } else if (PICS_IS_IUT_SECURED == true) {
        if(e_success != f_acEnableSecurity()){
          log("*** INFO: TEST CASE NOW STOPPING ITSELF! ***");
          stop;
        }
      }
    } // End of function f_initialiseSecuredMode()
        
    function f_uninitialiseSecuredMode() runs on ItsBaseGeoNetworking {
      if ((PICS_GN_SECURITY == true) or (PICS_IS_IUT_SECURED == true)) {
        f_acDisableSecurity();
      }
    } // End of function f_uninitialiseSecuredMode()
        
  } // End of group geoConfigurationFunctions
garciay's avatar
garciay committed
838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203
    
  group componentFunctions {
    /**
     * @desc    Get the component  corresponding to a key
     * @param   p_componentName   Name searched component
     * @return  ItsGeoNetworking - The searched position vector
     */
    function f_getComponent(
                            in charstring p_componentName
                            ) runs on ItsMtc
    return ItsGeoNetworking {
            
      var ItsGeoNetworking v_return := null;
      var integer i := 0;
            
      for (i:=0; i<lengthof(vc_componentTable); i:=i+1) {
        if (vc_componentTable[i].componentName == p_componentName) {
          if (isvalue(vc_componentTable[i].gnComponent)) {
          v_return := valueof(vc_componentTable[i].gnComponent);
          }
          else {
            testcase.stop(__SCOPE__ & " can not handle omitted GN components");
          }
        }
      }
            
      return v_return;
    }
  }
    
  group geoPositionFunctions {
        
    /**
     * @desc   Prepare positions and areas tables according to general constellation 
     * @param p_positionTable  Position Table
     * @param p_areaTable      Area Table
     */
    function f_preparePositionsAndAreas(
                                        inout PositionTable p_positionTable,
                                        inout GeoAreaTable p_areaTable,
                                        in template (omit) LongPosVector p_longPosVectorIut := omit
                                        ) runs on ItsBaseGeoNetworking {
            
      var LongPosVector v_longPosVectorIut, v_longPosVectorNodeA, v_longPosVectorNodeB, v_longPosVectorNodeC, v_longPosVectorNodeD, v_longPosVectorNodeE, v_longPosVectorNodeF;
            
      // Get positions
      if (not(ispresent(p_longPosVectorIut))) {
        v_longPosVectorIut := f_getIutLongPosVector();
      } else {
        v_longPosVectorIut := valueof(p_longPosVectorIut);
      }
    v_longPosVectorNodeA := f_computePosition(v_longPosVectorIut, c_longitudeFactorNodeA, c_latitudeFactorNodeA);
    v_longPosVectorNodeB := f_computePosition(v_longPosVectorIut, c_longitudeFactorNodeB, c_latitudeFactorNodeB);
    v_longPosVectorNodeC := f_computePosition(v_longPosVectorIut, c_longitudeFactorNodeC, c_latitudeFactorNodeC);
    v_longPosVectorNodeD := f_computePosition(v_longPosVectorIut, c_longitudeFactorNodeD, c_latitudeFactorNodeD);
    v_longPosVectorNodeE := f_computePosition(v_longPosVectorIut, c_longitudeFactorNodeE, c_latitudeFactorNodeE);
    v_longPosVectorNodeF := f_computePosition(v_longPosVectorIut, c_longitudeFactorNodeF, c_latitudeFactorNodeF);
            
      // Propagate GN addresses
    v_longPosVectorNodeA.gnAddr := f_getTsGnLocalAddress(c_compNodeA);
    v_longPosVectorNodeB.gnAddr := f_getTsGnLocalAddress(c_compNodeB);
    v_longPosVectorNodeC.gnAddr := f_getTsGnLocalAddress(c_compNodeC);
    v_longPosVectorNodeD.gnAddr := f_getTsGnLocalAddress(c_compNodeD);
    v_longPosVectorNodeE.gnAddr := f_getTsGnLocalAddress(c_compNodeE);
    v_longPosVectorNodeF.gnAddr := f_getTsGnLocalAddress(c_compNodeF);
            
      // Position table
      f_addPosition(p_positionTable, c_compIut, v_longPosVectorIut);
      f_addPosition(p_positionTable, c_compNodeA, v_longPosVectorNodeA);
      f_addPosition(p_positionTable, c_compNodeB, v_longPosVectorNodeB);
      f_addPosition(p_positionTable, c_compNodeC, v_longPosVectorNodeC);
      f_addPosition(p_positionTable, c_compNodeD, v_longPosVectorNodeD);
      f_addPosition(p_positionTable, c_compNodeE, v_longPosVectorNodeE);
      f_addPosition(p_positionTable, c_compNodeF, v_longPosVectorNodeF);
            
      // Area table
      f_addArea(p_areaTable, c_area1,
                f_computeCircularArea(v_longPosVectorNodeD, float2int(5.0 * f_distance(v_longPosVectorNodeB, v_longPosVectorNodeD))));
      f_addArea(p_areaTable, c_area2,
                f_computeCircularArea(v_longPosVectorNodeB, float2int(1.5 * f_distance(v_longPosVectorNodeB, v_longPosVectorNodeD))));               
            
    }
        
    /**
     * @desc    Add a position vector in position table
     * @param   p_positionTable Position table to be updated
     * @param   p_positionKey   Reference key of the added position vector
     * @param   p_positionValue Added position vector
     */
    function f_addPosition(
                           inout PositionTable p_positionTable,
                           in charstring p_positionKey,
                           in LongPosVector p_positionValue
                           ) {
            
      p_positionTable[lengthof(p_positionTable)] := {
      key := p_positionKey,
      position := p_positionValue
      };
    }
    
    /**
     * @desc    Get the position vector corresponding to a key
     * @param   p_positionKey   Reference key of the searched position vector
     * @return  LongPosVector - The searched position vector
     */
    function f_getPosition(
                           in charstring p_positionKey
                           ) runs on ItsGeoNetworking
    return LongPosVector {
            
      var LongPosVector v_return;
      var integer i := 0;
            
      for (i:=0; i<lengthof(vc_positionTable); i:=i+1) {
        if (vc_positionTable[i].key == p_positionKey) {
            v_return := vc_positionTable[i].position;
        }
      }
            
      return v_return;
    }
        
    /**
     * @desc    Set the position vector corresponding to a ComponentNode
     * @param   p_compNode  Reference to the Component to be changed
     * @param   p_longPosVector - The new position vector
     */

    function f_changePositon(
                             in charstring p_compNode,
                             in LongPosVector p_longPosVector
                             ) runs on ItsGeoNetworking {
            
      var integer i := 0;

      for (i:=0; i<lengthof(vc_positionTable); i:=i+1) {
        if (vc_positionTable[i].key == p_compNode) {
          vc_positionTable[i].position := p_longPosVector;
          break;
        }
      }
    }
        
    /**
     * @desc    Compute a position based on reference point and distance factors
     * @param   p_refPosition       Reference point
     * @param   p_longitudeFactor   Number of DISTANCE_UNIT applied for computing longitude
     * @param   p_latitudeFactor    Number of DISTANCE_UNIT applied for computing latitude
     * @return  LongPosVector - Computed position
     * @see     PICS_GN_DEFAULT_MAX_COMMUNICATION_RANGE
     */
    function f_computePosition(
                               in LongPosVector p_refPosition,
                               in integer p_longitudeFactor,
                               in integer p_latitudeFactor
                               ) return LongPosVector {
            
      const integer c_distance2Gps := 100;
      var LongPosVector v_return := p_refPosition;                        
      var UInt32 v_distanceUnit := (c_distance2Gps * PICS_GN_DEFAULT_MAX_COMMUNICATION_RANGE) / 10;
            
    v_return.latitude := v_return.latitude + p_latitudeFactor * v_distanceUnit;
    v_return.longitude := v_return.longitude + p_longitudeFactor * v_distanceUnit;
    v_return.timestamp_ := f_computeGnTimestamp();
    v_return.pai := int2bit(1,1);
            
      return v_return;
    }
        
    /**
     * @desc    Add a geoArea in geoArea table
     * @param   p_geoAreaTable  GeoArea table to be updated
     * @param   p_areaKey       Reference key of the added geoArea
     * @param   p_geoArea       Added geoArea
     */
    function f_addArea(
                       inout GeoAreaTable p_geoAreaTable,
                       in charstring p_areaKey,
                       in GeoArea p_geoArea
                       ) {
      p_geoAreaTable[lengthof(p_geoAreaTable)] := {
      key := p_areaKey,
      geoArea := p_geoArea
      };
    }
        
    /**
     * @desc    Get the geoArea corresponding to a key
     * @param   p_areaName   Reference key of the searched geoArea
     * @return  GeoArea - The serached geoArea
     */
    function f_getArea(
                       in charstring p_areaName
                       ) runs on ItsGeoNetworking
    return GeoArea {
      var GeoArea v_return;
      var integer i := 0;
            
      for (i:=0; i<lengthof(vc_areaTable); i:=i+1) {
        if (vc_areaTable[i].key == p_areaName) {
        v_return := vc_areaTable[i].geoArea;
        }
      }
            
      return v_return;
    }
        
    /**
     * @desc    Get the geoBroadcastArea corresponding to a key
     * @param   p_areaName   Reference key of the searched geoBroadcastArea
     * @return  GeoBroadcastArea - The serached geoBroadcastArea
     */
    function f_getGeoBroadcastArea(in charstring p_areaName) runs on ItsGeoNetworking
    return GeoBroadcastArea {
      return f_geoArea2GeoBroadcastArea(f_getArea(p_areaName));
    }
        
    /**
     * @desc    Get the GeoAnycastArea corresponding to a key
     * @param   p_areaName   Reference key of the searched GeoAnycastArea
     * @return  GeoAnycastArea - The serached GeoAnycastArea
     */
    function f_getGeoAnycastArea(in charstring p_areaName) runs on ItsGeoNetworking
    return GeoAnycastArea {
      return f_geoArea2GeoAnycastArea(f_getArea(p_areaName));
    }
        
    /**
     * @desc    Convert GeoArea type to GeoBroadcastArea
     * @param   p_area  GeoArea to be converted
     * @return  GeoBroadcastArea
     */
    function f_geoArea2GeoBroadcastArea(GeoArea p_area)
    return GeoBroadcastArea {
      var GeoBroadcastArea v_broadcastArea;
            
      if (p_area.shape == e_geoCircle) {
      v_broadcastArea.geoBroadcastSubType := e_geoBroadcastCircle;
      }
      else if (p_area.shape == e_geoRect) {
      v_broadcastArea.geoBroadcastSubType := e_geoBroadcastRect;
      }
      else if (p_area.shape == e_geoElip) {
      v_broadcastArea.geoBroadcastSubType := e_geoBroadcastElip;
      }
      else {
      v_broadcastArea.geoBroadcastSubType := e_reserved;
      }
            
    v_broadcastArea.geoBroadcastArea := p_area.area;
            
      return v_broadcastArea;
    }
        
    /**
     * @desc    Convert GeoArea type to GeoAnycastArea
     * @param   p_area  GeoArea to be converted
     * @return  GeoAnycastArea
     */
    function f_geoArea2GeoAnycastArea(GeoArea p_area)
    return GeoAnycastArea {
      var GeoAnycastArea v_anycastArea;
            
      if (p_area.shape == e_geoCircle) {
      v_anycastArea.geoAnycastSubType := e_geoAnycastCircle;
      }
      else if (p_area.shape == e_geoRect) {
      v_anycastArea.geoAnycastSubType := e_geoAnycastRect;
      }
      else if (p_area.shape == e_geoElip) {
      v_anycastArea.geoAnycastSubType := e_geoAnycastElip;
      }
      else {
      v_anycastArea.geoAnycastSubType := e_reserved;
      }
            
    v_anycastArea.geoAnycastArea := p_area.area;
            
      return v_anycastArea;
    }
        
    /**
     * @desc    Compute a square geoArea
     * @param   p_centerLongPosVector   Center point of the square area
     * @param   p_distanceA             Width of the square area in meters
     * @return  GeoArea - Computed geoArea
     */
    function f_computeSquareArea(
                                 in LongPosVector p_centerLongPosVector,
                                 in UInt16 p_distanceA
                                 ) return GeoArea {
            
      var GeoArea v_geoArea;
            
    v_geoArea := {
      shape := e_geoRect,
      area := {
        geoAreaPosLatitude := p_centerLongPosVector.latitude,
        geoAreaPosLongitude := p_centerLongPosVector.longitude,
        distanceA := p_distanceA,
        distanceB := p_distanceA,
        angle := 0
        }
    }
            
      return v_geoArea;
    }
        
    /**
     * @desc    Compute a circular geoArea
     * @param   p_centerLongPosVector   Center point of the square area
     * @param   p_distanceA             Radius of the square area in meters
     * @return  GeoArea - Computed geoArea
     */
    function f_computeCircularArea(
                                   in LongPosVector p_centerLongPosVector,
                                   in UInt16 p_distanceA
                                   ) return GeoArea {
                
      var GeoArea v_geoArea;
            
    v_geoArea := {
      shape := e_geoCircle,
      area := {
        geoAreaPosLatitude := p_centerLongPosVector.latitude,
        geoAreaPosLongitude := p_centerLongPosVector.longitude,
        distanceA := p_distanceA,
        distanceB := 0,
        angle := 0
        }
    }
            
      return v_geoArea;
    }
        
    /**
     * @desc    Compute radius of an circular area
     * @param   p_squareMeters  Square meters of an circular area
     * @return  Computed radius in meters
     * @see     fx_computeRadiusFromCircularArea
     */
    function f_radiusFromCircularArea(
                                      in float p_squareMeters
                                      ) return float {
         
      //            log("*** f_distance: INFO: calling fx_computeRadiusFromCircularArea() ***");
      return fx_computeRadiusFromCircularArea(p_squareMeters);
    }
        
    /**
     * @desc    Compute distance between two points
     * @param   p_pointA    First point
     * @param   p_pointB    Second point
     * @return  Computed distance in meters
     * @see     fx_computeDistance
     */
    function f_distance(
                        in LongPosVector p_pointA,
                        in LongPosVector p_pointB
                        ) return float {
         
      //            log("*** f_distance: INFO: calling fx_computeDistance() ***");
      return fx_computeDistance(p_pointA.latitude, p_pointA.longitude, p_pointB.latitude, p_pointB.longitude);
    }
        
  } // End of group geoPositionFunctions
garciay's avatar
garciay committed
    
  group geoAltsteps {
        
    /**
     * @desc The base default.
     */
    altstep a_default() runs on ItsGeoNetworking {
            
      var LongPosVector v_longPosVectorIut;
            
      [vc_gnDefaultActive] a_receiveLsRequest(
                                              ?, ?, v_longPosVectorIut
                                              ) {
        repeat;
      }
      /* FIXME To be reviewed [vc_gnDefaultActive] geoNetworkingPort.receive(
                                                     mw_geoNwInd(
                                                                 mw_geoNwSecPdu(
                                                                                mw_securedMessage_CAMs,
                                                                                ?
                                                                                ))) {
        // Skip CAM messages
        log("*** a_default: WARNING: Skip secured CAM messages ***");
        repeat;
      }*/
      [vc_gnDefaultActive] geoNetworkingPort.receive {
        log("*** a_default: WARNING: Received an unexpected message ***");
        repeat;
      }
      [] tc_wait.timeout {
        log("*** a_default: ERROR: Timeout while awaiting reaction of the IUT prior to Upper Tester action ***");
        f_selfOrClientSyncAndVerdict("error", e_timeout);
      }
      [] tc_ac.timeout {
        log("*** a_default: ERROR: Timeout while awaiting the reception of a message ***");
        f_selfOrClientSyncAndVerdict("error", e_timeout);
      }
      [] a_shutdown() {
        log("*** a_default: INFO: TEST COMPONENT NOW STOPPING ITSELF! ***");
        stop;
      }
    }
        
    /**
     * @desc    Neighbour default altstep (answers to LS Requests)
     */
    altstep a_neighbourDefault() runs on ItsGeoNetworking {
            
      [vc_gnDefaultActive] a_receiveLsRequestAndReply(
                                                      ?, f_getPosition(vc_componentName).gnAddr.mid,
                f_getPosition(vc_componentName)//,
                //Spirent removed f_getPosition(vc_componentName)
                                                      ) {
        repeat;
      }
      [vc_componentName == c_compNodeB and vc_gnDefaultActive] a_receiveLsRequestAndReply(
                                                                                          ?, f_getPosition(c_compNodeA).gnAddr.mid,
                f_getPosition(c_compNodeA)//,
                //Spirent removed f_getPosition(vc_componentName)
                                                                                          ) {
        repeat;
      }
      [] a_default() {
      }
    }
        
    /**
     * @desc The default for handling upper tester messages.
     */
    altstep a_utDefault() runs on ItsBaseGeoNetworking {
      var UtGnEventInd v_ind;
      [vc_utDefaultActive] utPort.receive(UtGnEventInd:?) -> value v_ind {
        //store every upper tester indication received
        vc_utInds[lengthof(vc_utInds)] := v_ind;
        repeat;
      }
      [vc_utDefaultActive] utPort.receive {
        log("*** " & testcasename() & ": INFO: Received unexpected UT message from IUT ***");
        repeat;
      }
    }
        
    /**
     * @desc Default handling cf01 de-initialisation.
     */
        altstep a_cf01Down() runs on ItsGeoNetworking {
      [] a_shutdown() {
        f_poDefault();
        f_cf01Down();
        log("*** a_cf01Down: INFO: TEST COMPONENT NOW STOPPING ITSELF! ***");
        stop;
      }
    }
        
    /**
     * @desc Default handling cf02 de-initialisation.
     */
        altstep a_cf02Down() runs on ItsMtc {
      [] a_shutdown() {
        f_cf02Down();
        log("*** a_cf02Down: INFO: TEST COMPONENT NOW STOPPING ITSELF! ***");
        stop;
      }
    }
        
    /**
     * @desc Default handling cf03 de-initialisation.
     */
        altstep a_cf03Down() runs on ItsMtc {
      [] a_shutdown() {
        f_cf03Down();
        log("*** a_cf03Down: INFO: TEST COMPONENT NOW STOPPING ITSELF! ***");
        stop;
      }
    }
        
    /**
     * @desc Default handling cf04 de-initialisation.
     */
        altstep a_cf04Down() runs on ItsMtc {
      [] a_shutdown() {
        f_cf04Down();
        log("*** a_cf04Down: INFO: TEST COMPONENT NOW STOPPING ITSELF! ***");
        stop;
      }
    }

    /**
     * @desc Default handling cf05 de-initialisation.
     */
        altstep a_cf05Down() runs on ItsMtc {
      [] a_shutdown() {
        f_cf05Down();
        log("*** a_cf05Down: INFO: TEST COMPONENT NOW STOPPING ITSELF! ***");
        stop;
      }
    }
        
    /**
     * @desc Default handling cf06 de-initialisation.
     */
        altstep a_cf06Down() runs on ItsMtc {
      [] a_shutdown() {
        f_cf06Down();
        log("*** a_cf06Down: INFO: TEST COMPONENT NOW STOPPING ITSELF! ***");
        stop;
      }
    }
        
    /**
     * @desc Default handling cf07 de-initialisation.
     */
        altstep a_cf07Down() runs on ItsMtc {
      [] a_shutdown() {
        f_cf07Down();
        log("*** a_cf07Down: INFO: TEST COMPONENT NOW STOPPING ITSELF! ***");
        stop;
      }
    }        
    group geoGeoUnicastAltsteps {
            
      /**
       * @desc    Receive GeoUnicast packet
       * @param   p_sourceLongPosVec          Expected source position vector
       * @param   p_destinationShortPosVec    Expected destination position vector
       * @param   p_seqNumber                 Expected sequence number
       */
      altstep a_receiveGeoUnicast(
                                  in template (present) ShortPosVector p_destinationShortPosVec,
                                  in template (present) UInt16 p_seqNumber
                                  ) runs on ItsGeoNetworking {
                
        [vc_gnDefaultActive] geoNetworkingPort.receive(mw_geoNwInd(mw_geoNwPdu(mw_geoNwUnicastPacket(
                                                                                                     p_destinationShortPosVec,
                                                                                                     p_seqNumber)))) {
        }
      }
            
      /**
       * @desc    Receive GeoUnicast packet for specific destination
       * @param   p_destinationShortPosVec    Expected destination position vector
       */
      altstep a_receiveGeoUnicastWithDestination(in template (present) ShortPosVector p_destinationShortPosVec) runs on ItsGeoNetworking {
                
        [vc_gnDefaultActive] a_receiveGeoUnicast(p_destinationShortPosVec, ?) {}
      }
            
      /**
       * @desc Receive any GeoUnicast packet
       */
      altstep a_receiveAnyGeoUnicast() runs on ItsGeoNetworking {
                
        [vc_gnDefaultActive] a_receiveGeoUnicast(?, ?) {}
      }
            
    } // End of group geoGeoUnicastAltsteps
garciay's avatar
garciay committed
        
    group geoGeoBroadcastAltsteps {
            
      /**
       * @desc Receive GeoBroadcast packet
       * @param   p_srcLongPosVec     Expected source position vector
       * @param   p_seqNumber         Expected sequence number
       */
      altstep a_receiveGeoBroadcast(
                                    in template (present) LongPosVector p_srcLongPosVec,
                                    in template (present) UInt16 p_seqNumber
                                    ) runs on ItsGeoNetworking {
                
        [vc_gnDefaultActive] geoNetworkingPort.receive(mw_geoNwInd(mw_geoNwPdu(mw_geoNwBroadcastPacket(
                                                                                                       p_srcLongPosVec,
                                                                                                       p_seqNumber
                                                                                                       )))) {
        }
      }
            
      /**
       * @desc Receive GeoBroadcast packet with specific Area and HopLimit
       * @param   p_srcLongPosVec     Expected source position vector
       * @param   p_seqNumber         Expected sequence number
       * @param   p_broadcastArea     Expected geoBroadcastArea
       * @param   p_routerHopLimit    Expected router hop limit
       * @param   p_maxHopLimit       Expected max hop limit (Default: ?)
       */
      altstep a_receiveGeoBroadcastWithAreaWithHopLimit(
                                                        in template (present) LongPosVector p_srcLongPosVec,
                                                        in template (present) UInt16 p_seqNumber,
                                                        in template (present) GeoBroadcastArea p_broadcastArea,
                                                        in template (present) UInt8 p_routerHopLimit,
                                                        in template (present) UInt8 p_maxHopLimit := ?
                                                        ) runs on ItsGeoNetworking {
                
        [vc_gnDefaultActive] geoNetworkingPort.receive(mw_geoNwInd(mw_geoNwPdu(mw_geoNwBroadcastPacketWithAreaAndHl(
                                                                                                                    p_srcLongPosVec,
                                                                                                                    p_seqNumber,
                                                                                                                    p_broadcastArea,
                                                                                                                    p_maxHopLimit
                                                                                                                    ),
                                                                               -,
                                                                               p_routerHopLimit
                                                                               ))) {
        }
      }
            
      /**
       * @desc Receive GeoBroadcast packet for specific Geobroadcast Area
       * @param   p_srcLongPosVec     Expected source position vector
       * @param   p_seqNumber         Expected sequence number
       * @param   p_broadcastArea     Expected geoBroadcastArea
       */
      altstep a_receiveGeoBroadcastWithArea(
                                            in template (present) LongPosVector p_srcLongPosVec,
                                            in template (present) UInt16 p_seqNumber,
                                            in template (present) GeoBroadcastArea p_broadcastArea
                                            ) runs on ItsGeoNetworking {
                
        [vc_gnDefaultActive] geoNetworkingPort.receive(mw_geoNwInd(mw_geoNwPdu(mw_geoNwBroadcastPacketWithArea(
                                                                                                               p_srcLongPosVec,
                                                                                                               p_seqNumber,
                                                                                                               p_broadcastArea
                                                                                                               )))) {
        }
      }
            
    } // End of group geoGeoBroadcastAltsteps
garciay's avatar
garciay committed
        
    group geoGeoAnycastAltsteps {
            
      /**
       * @desc Receive GeoAnycast packet
       * @param   p_srcLongPosVec     Expected source position vector
       * @param   p_senderLongPosVec  Expected sender position vector
       * @param   p_seqNumber         Expected sequence number
       */
      altstep a_receiveGeoAnycast(
                                  in template (present) LongPosVector p_srcLongPosVec,
                                  in template (present) LongPosVector p_senderLongPosVec,
                                  in template (present) UInt16 p_seqNumber
                                  ) runs on ItsGeoNetworking {
                
        [vc_gnDefaultActive] geoNetworkingPort.receive(mw_geoNwInd(mw_geoNwPdu(mw_geoNwAnycastPacket(
                                                                                                     p_srcLongPosVec,
                                                                                                     p_seqNumber
                                                                                                     )))) {
        }
      }
            
      /**
       * @desc Receive GeoAnycast packet with specific Area and HopLimit
       * @param   p_srcLongPosVec     Expected source position vector
       * @param   p_senderLongPosVec  Expected sender position vector
       * @param   p_seqNumber         Expected sequence number
       * @param   p_anycastArea       Expected geoAnycastArea
       * @param   p_hopLimit          Expected hop limit
       * @param   p_maxHopLimit       Expected max hop limit (Default: ?)
       */
      altstep a_receiveGeoAnycastWithAreaWithHopLimit(
                                                      in template (present) LongPosVector p_srcLongPosVec,
                                                      in template (present) UInt16 p_seqNumber,
                                                      in template (present) GeoAnycastArea p_anycastArea,
                                                      in template (present) UInt8 p_hopLimit,
                                                      in template (present) UInt8 p_maxHopLimit := ?
                                                      ) runs on ItsGeoNetworking {
                
        [vc_gnDefaultActive] geoNetworkingPort.receive(mw_geoNwInd(mw_geoNwPdu(mw_geoNwAnycastPacketWithArea(
                                                                                                             p_srcLongPosVec,
                                                                                                             p_seqNumber,
                                                                                                             p_anycastArea
                                                                                                             ),
                                                                               -,
                                                                               p_hopLimit
                                                                               ))) {
        }
      }
            
      /**
       * @desc Receive GeoAnycast packet for specific GeoAnycast Area
       * @param   p_srcLongPosVec     Expected source position vector
       * @param   p_seqNumber         Expected sequence number
       * @param   p_anycastArea       Expected geoAnycastArea
       */
      altstep a_receiveGeoAnycastWithArea(
                                          in template (present) LongPosVector p_srcLongPosVec,
                                          in template (present) UInt16 p_seqNumber,
                                          in template (present) GeoAnycastArea p_anycastArea
                                          ) runs on ItsGeoNetworking {
                
        [vc_gnDefaultActive] geoNetworkingPort.receive(mw_geoNwInd(mw_geoNwPdu(mw_geoNwAnycastPacketWithArea(
                                                                                                             p_srcLongPosVec,
                                                                                                             p_seqNumber,
                                                                                                             p_anycastArea
                                                                                                             )))) {
        }
      }
            
    } // End of group geoGeoAnycastAltsteps
garciay's avatar
garciay committed
        
    group geoLocationServiceAltsteps {
            
      /**
       * @desc    Receive Location Service Request
       * @param   p_seqNumber Expected sequence number of the received LS Request
       * @param   p_mid GN address expected in received LS Request
       * @param   p_reqSrcPosVector Expected source position vector of the received LS Request
       */
      altstep a_receiveLsRequest(
                                 in template (present) UInt16 p_seqNumber,
                                 in template (present) GN_Address.mid p_mid,
                                 out LongPosVector p_reqSrcPosVector
                                 ) runs on ItsGeoNetworking {
        var GeoNetworkingInd v_msg;
        
        [vc_gnDefaultActive] geoNetworkingPort.receive(
                                                       mw_geoNwInd(
                                                                   mw_geoNwPdu(
                                                                               mw_geoNwLsRequestPacket(
                                                                                                       p_seqNumber,
                                                                                                       p_mid
                                                                                                       )
                                                                               )
                                                                   )
                                                       ) -> value v_msg {
        p_reqSrcPosVector := valueof(v_msg.msgIn.gnPacket.packet.extendedHeader.lsRequestHeader.srcPosVector);
        }
      }
            
      /**
       * @desc Receive any Location Service Request
       */
      altstep a_receiveAnyLsRequest() runs on ItsGeoNetworking {
        var LongPosVector v_reqSrcPosVector;
                
        [vc_gnDefaultActive] a_receiveLsRequest(?, ?, v_reqSrcPosVector) {}
      }
            
      /**
       * @desc Receive any Location Service Reply
       */
      altstep a_receiveAnyLsReply() runs on ItsGeoNetworking {
        [vc_gnDefaultActive] geoNetworkingPort.receive( mw_geoNwInd( mw_geoNwPdu( mw_geoNwLsReplyPacket(?, ?) ))) {
          //ignore and repeat
          repeat;
        }
      }
            
      /**
       * @desc Receive Location Service Request and send Location Service Reply
       * @param   p_reqSeqNumber          Expected sequence number of the received LS Request
       * @param   p_gnAddress             GN address expected in received LS Request
       * @param   p_repSrcPosVector       Source position vector of the sent LS Response
       */
      altstep a_receiveLsRequestAndReply(
                                         in template (present) UInt16 p_reqSeqNumber,
                                         in template (value) GN_Address.mid p_mid,
                in template (value) LongPosVector p_repSrcPosVector
                                         ) runs on ItsGeoNetworking {
        var LongPosVector v_repDstPosVector;
                
        [vc_gnDefaultActive] a_receiveLsRequest(p_reqSeqNumber, p_mid, v_repDstPosVector) {
          f_sendGeoNetMessage(valueof(m_geoNwReq_linkLayerBroadcast(m_geoNwPdu(
                                                                               m_geoNwLsReplyPacket(
                                                                                                    p_repSrcPosVector,
                                                                                                    f_longPosVector2ShortPosVector(v_repDstPosVector),
                                                                                                    vc_localSeqNumber
                                                                                                    )))));
        }
      }
          
    } // End of group geoLocationServiceAltsteps
  } // End of group geoAltsteps
garciay's avatar
garciay committed
    
  group preambles {
        
    /**
     * @desc The default preamble.
     */
    function f_prDefault() runs on ItsGeoNetworking {
      activate(a_default());
      activate(a_utDefault());
    }
        
    /**
     * @desc Preamble for non-neighbour nodes
     */
    function f_prNonNeighbour() runs on ItsGeoNetworking {
      f_prDefault();
    }
        
    /**
     * @desc Preamble for neighbour nodes
     */
    function f_prNeighbour() runs on ItsGeoNetworking {
      f_prDefault();
      f_startBeingNeighbour();
      f_sleep(0.5);
    }
        
    /**
     * @desc Brings the IUT into an initial state.
     * @remark Component variable vc_hashedId8ToBeUsed shall be set with the IUT certificate to be used
     */
    function f_initialState(Scenario p_scenario := e_staticPosition) runs on ItsBaseGeoNetworking {
            
      if (PICS_GN_SECURITY) {
        var Oct8 v_hashedId8ToBeUsed := f_setupIutCertificate(vc_hashedId8ToBeUsed);
        if (oct2int(v_hashedId8ToBeUsed) == 0) {
        v_hashedId8ToBeUsed := 'FFFFFFFFFFFFFFFF'O; // Reset to unknown value, the IUT will use its own certificates
        }
        f_utInitializeIut(m_secGnInitialize(v_hashedId8ToBeUsed));
      } // else, default behavior
      else {
        f_utInitializeIut(m_gnInitialize);
      }
      f_sleep(PX_NEIGHBOUR_DISCOVERY_DELAY);
      
      f_acLoadScenario(p_scenario);
      f_acStartScenario();
            f_acAwaitTimeInRunningScenario(f_getTimeForGpsFix());
    }
        
    /**
     * @desc    Receive and reply to LS Requests
     * @param   p_reqSeqNumber          Expected sequence number of the received LS Request
     * @param   p_gnAddress             GN address expected in received LS Request
     * @param   p_repSrcPosVector       Source position vector of the sent LS Response
     * @param   p_repSenderPosVector    Sender position vector of the sent LS Response
     */
    function f_handleLocationService(
                                     in template (present) UInt16 p_reqSeqNumber,
                                     in template (value) GN_Address.mid p_mid,
                                     in template (value) LongPosVector p_repSrcPosVector,
                                     in template (value) LongPosVector p_repSenderPosVector
                                     ) runs on ItsGeoNetworking {
            
      tc_ac.start;
      alt {
                [] a_receiveLsRequestAndReply(p_reqSeqNumber, p_mid, p_repSrcPosVector) {//Spirent removed, p_repSenderPosVector) {
          tc_ac.stop;
        }
      }
            
    }
        
    /**
     * @desc    Send LS request and receive LS Reply
     * @param   p_reqSrcPosVector   Source position vector of the sent LS Request
     * @param   p_reqSeqNumber      Sequence number of the sent LS Request
     * @param   p_gnAddress         GN address for which the LS Request is sent
     * @param   p_repSrcPosVector   Expected source position vector in received LS Response
     * @return  FncRetCode
     */
    function f_processLocationService(
                                      in template (value) LongPosVector p_reqSrcPosVector,
                                      in template (value) UInt16 p_reqSeqNumber,
                                      in template (value) GN_Address p_gnAddress,
                                      out LongPosVector p_repSrcPosVector
                                      ) runs on ItsGeoNetworking return FncRetCode {
      var FncRetCode v_ret := e_error;
      var GeoNetworkingInd v_msg;
            
      f_sendGeoNetMessage(
                          valueof(
                                  m_geoNwReq_linkLayerBroadcast(
                                                                m_geoNwPdu(
                                                                           m_geoNwLsRequestPacket(
                                                                                                  p_reqSrcPosVector,
                                                                                                  p_reqSeqNumber,
                                                                                                  p_gnAddress
                                                                                                  )
                                                                           )
                                                                )
                                  )
                          );
            
      tc_ac.start;
      alt {
        [] geoNetworkingPort.receive(
                                     mw_geoNwInd(
                                                 mw_geoNwPdu(
                                                             mw_geoNwLsReplyPacket(
                                                                                   ?,
                                                                                   mw_shortPosVectorPosition(f_longPosVector2ShortPosVector(valueof(p_reqSrcPosVector)))
                                                                                   )
                                                             )
                                                 )
                                     ) -> value v_msg {
          tc_ac.stop;
        p_repSrcPosVector := valueof(v_msg.msgIn.gnPacket.packet.extendedHeader.lsReplyHeader.srcPosVector);
        v_ret := e_success;
        }
      }
            
      return v_ret;
    }
        
  } // End of group preambles
garciay's avatar
garciay committed
    
  group postambles {
        
    /**
     * @desc The default postamble.
     */
    function f_poDefault() runs on ItsGeoNetworking {
      f_acStopScenario();
    }
        
    /**
     * @desc Postamble for neighbour nodes
     */
    function f_poNeighbour() runs on ItsGeoNetworking {
      f_stopBeingNeighbour();
      f_poDefault();
    }
        
  } // End of group postambles
garciay's avatar
garciay committed
    
  group adapterControl {
        
    /**
     * @desc    Triggers event in the test system adaptation.
     * @param   p_event The event to trigger
     * @return  FncRetCode
     */
    function f_acTriggerEvent(template (value) AcGnPrimitive p_event) runs on ItsBaseGeoNetworking return FncRetCode {
      var FncRetCode v_ret := e_success;
            
      acPort.send(p_event);
            
      return v_ret;
    }
        
    /**
     * @desc    Get the position vector corresponding to a specific GN address
     * @param   p_gnAddress     GN address for which the search is performed
     * @return  LongPosVector - IUT's position
     */
    function f_acGetLongPosVector(GN_Address p_gnAddress) runs on ItsBaseGeoNetworking return LongPosVector {
      var AcGnResponse v_result;

      f_acTriggerEvent(m_getLongPosVector(p_gnAddress));
      tc_ac.start;
      alt {
        [] acPort.receive(mw_getLongPosVectorAny(p_gnAddress)) -> value v_result {
          tc_ac.stop;
        }
        [] acPort.receive {
          tc_ac.stop;
          log("*** f_acGetLongPosVector: ERROR: Received unexpected message ***");
          f_selfOrClientSyncAndVerdict("error", e_error);
        }
        [] tc_ac.timeout {
          log("*** f_acGetLongPosVector: ERROR: Timeout while waiting for adapter control event result ***");
          f_selfOrClientSyncAndVerdict("error", e_timeout);
        }
      }
            
      return v_result.getLongPosVector;
    }
        
    /**
     * @desc    Triggers test adapter to send beacons for multiple neighbours
     * @param   p_numberOfNeighbour Number of neighbours to simulate
     * @return  FncRetCode
     */
    function f_acStartBeaconingMultipleNeighbour(in integer p_numberOfNeighbour) runs on ItsGeoNetworking return FncRetCode {
            
      return f_acTriggerEvent(m_startBeaconingMultipleNeighbour(m_beaconHeader(f_getPosition(vc_componentName)).beaconHeader, p_numberOfNeighbour));
            
    }
        
    /**
     * @desc    Triggers test adapter to enable security support
     * @return  FncRetCode
     */
    function f_acEnableSecurity() runs on ItsBaseGeoNetworking return FncRetCode {
            
            // Local variables
            
            // Load certificates
            if (PICS_GN_SECURITY) {
                if( not f_loadCertificates(PX_IUT_SEC_CONFIG_NAME) ) {
                    return e_error;
                }
                
                // Initialize vc_location
                f_setGenerationLocation(
                    f_getTsLatitude(),
                    f_getTsLongitude()
                );
                return f_acTriggerSecEvent(m_acEnableSecurity(cc_taCert_A));
            }
      return f_acTriggerSecEvent(m_acEnableSecurity(PX_CERT_FOR_TS));
    }
        
    /**
     * @desc    Triggers test adapter to disable security support
     * @return  FncRetCode
     */
    function f_acDisableSecurity() runs on ItsBaseGeoNetworking return FncRetCode {
            
      f_unloadCertificates();
            
      return f_acTriggerSecEvent(m_acDisableSecurity);
            
    }
        
    /**
     * @desc    Triggers event in the test system adaptation.
     * @param   p_event The event to trigger
     * @return  FncRetCode
     */
    function f_acTriggerSecEvent(
                                 in template (value) AcSecPrimitive p_event
                                 ) runs on ItsBaseGeoNetworking return FncRetCode {
      var FncRetCode v_ret := e_success;
            
      acPort.send(p_event);
      tc_ac.start;
      alt {
        [] acPort.receive(m_acSecResponseSuccess) {
          tc_ac.stop;
        }
        [] acPort.receive {
          tc_ac.stop;
          log("*** " & __SCOPE__ & ": ERROR: Received unexpected message ***");
          f_selfOrClientSyncAndVerdict("error", e_error);
        }
        [] tc_ac.timeout {
          log("*** " & __SCOPE__ & ": ERROR: Timeout while waiting for adapter control event result ***");
          f_selfOrClientSyncAndVerdict("error", e_timeout);
        }
      }
            
      return v_ret;
    }
        
    /**
     * @desc    Triggers event in the test system adaptation.
     * @param   p_event The event to trigger
     * @return  FncRetCode
     */
    function f_acTriggerGnssEvent(template (value) AcGnssPrimitive p_event) runs on ItsBaseGeoNetworking return FncRetCode {
      var FncRetCode v_ret := e_success;
            
      acPort.send(p_event);
      tc_ac.start;
      alt {
        [] acPort.receive(m_acGnssResponseSuccess) {
          tc_ac.stop;
        }
        [] acPort.receive {
          tc_ac.stop;
          log("*** f_acTriggerGnssEvent: ERROR: Received unexpected message ***");
          f_selfOrClientSyncAndVerdict("error", e_error);
        }
        [] tc_ac.timeout {
          log("*** f_acTriggerGnssEvent: ERROR: Timeout while waiting for adapter control event result ***");
          f_selfOrClientSyncAndVerdict("error", e_timeout);
        }
      }
            
      return v_ret;
    }
        
    /**
     * @desc    Loads the given scenario
     * 
     * @param   p_scenario   The scenario to load.
     */
    function f_acLoadScenario(Scenario p_scenario) runs on ItsBaseGeoNetworking {
            
      if (PX_GNSS_SCENARIO_SUPPORT==true) {
        f_acTriggerGnssEvent(m_loadScenario(p_scenario));
      }
        } // End of function f_acLoadScenario
garciay's avatar
garciay committed
        
    /**
     * @desc    Starts a loaded scenario
     */
    function f_acStartScenario() runs on ItsBaseGeoNetworking {
            
      if (PX_GNSS_SCENARIO_SUPPORT==true) {
        f_acTriggerGnssEvent(m_startScenario);
      vc_scenarioStarted := true;
      }
        } // End of function f_acStartScenario
garciay's avatar
garciay committed
        
    /**
     * @desc    Stops a loaded scenario
     */
    function f_acStopScenario() runs on ItsBaseGeoNetworking {
            
      if (PX_GNSS_SCENARIO_SUPPORT==true and vc_scenarioStarted==true) {
        f_acTriggerGnssEvent(m_stopScenario);
      vc_scenarioStarted := false;
      }
        } // End of function f_acStopScenario
garciay's avatar
garciay committed
        
        function f_acAwaitTimeInRunningScenario(integer p_time) runs on ItsBaseGeoNetworking return FncRetCode {
            var FncRetCode v_ret := e_success;
            
            if (PX_GNSS_SCENARIO_SUPPORT==true and vc_scenarioStarted==true) {
                f_acTriggerGnssEvent(m_timeInRunningScenario(p_time));
                
                tc_ac.start(int2float(p_time)*1.1);
                alt {
                    [] acPort.receive(m_acGnssTimeReachedSuccess) {
                        tc_ac.stop;
                    }
                    [] acPort.receive(m_acGnssTimeReachedError) {
                        tc_ac.stop;
                        log("*** " & __SCOPE__ & ": ERROR: Received unexpected message ***");
                        f_selfOrClientSyncAndVerdict("error", e_error);
                    }
                    [] tc_ac.timeout {
                        log("*** " & __SCOPE__ & ": ERROR: Timeout while waiting for time reached indication ***");
                        f_selfOrClientSyncAndVerdict("error", e_timeout);
                    }
                }
                
            }
            return v_ret;
        } // End of function f_acAwaitTimeInRunningScenario
garciay's avatar
garciay committed
        
  } // End of group adapterControl
garciay's avatar
garciay committed
    
  group commonFunctions {
        
    /**
     * @desc    Gets the value of the lifetime in seconds.
     * @param   p_lifetime Lifetime to be converted
     * @return  Lifetime in seconds
     */
    function f_getLifetimeValue(in Lifetime p_lifetime) runs on ItsGeoNetworking return float {
      var float v_lifetime := 0.0;
          
      select (p_lifetime.ltBase) {
      case (e_50ms) {
      v_lifetime := int2float(p_lifetime.multiplier) * 0.5;
      }
      case (e_1s) {
      v_lifetime := int2float(p_lifetime.multiplier) * 1.0;
      }
      case (e_10s) {
      v_lifetime := int2float(p_lifetime.multiplier) * 10.0;
      }
      case (e_100s) {
      v_lifetime := int2float(p_lifetime.multiplier) * 100.0;
      }
      }
          
      return v_lifetime;
    }
        
    /**
     * @desc    Computes GN timestamp based on current time
     * @return  Unix-Epoch-Time mod 2^32
     */
    function f_computeGnTimestamp() return UInt32 {
            
      //  Timestamp is 1s older than current time to avoid sending beacons coming from the future (time sync between nodes)
      var UInt32 v_timestamp := fx_computeGnTimestamp() - 1000;
      return v_timestamp;    
    }
        
  } // End of group commonFunctions
garciay's avatar
garciay committed
    
  group testerFunctions {
        
    /**
     * @desc    Gets the tester GN local address for a specific node
     * @param   p_node  Simulated node
     * @return  GN address of simulated node
     */
    function f_getTsGnLocalAddress(in charstring p_node) return GN_Address {
      var GN_Address v_gnAddr := valueof(m_dummyGnAddr);
            
      select (p_node) {
      case (c_compNodeA) {
      v_gnAddr := PX_TS_NODE_A_LOCAL_GN_ADDR;
      }
      case (c_compNodeB) {
      v_gnAddr := PX_TS_NODE_B_LOCAL_GN_ADDR;
      }
      case (c_compNodeC) {
      v_gnAddr := PX_TS_NODE_C_LOCAL_GN_ADDR;
      }
      case (c_compNodeD) {
      v_gnAddr := PX_TS_NODE_D_LOCAL_GN_ADDR;
      }
      case (c_compNodeE) {
      v_gnAddr := PX_TS_NODE_E_LOCAL_GN_ADDR;
      }
      case (c_compNodeF) {
      v_gnAddr := PX_TS_NODE_F_LOCAL_GN_ADDR;
      }
      case else {
        log("*** f_getTsGnLocalAddress: INFO: Unknown component " & p_node & " ***");
      }
      }
            
      return v_gnAddr;
    }
        
    /**
     * @desc    Sends a GeoNetworking message and in case of an included sequence number in the message the
     *          local sequence number will be increased by one.
     * @param   p_geoNetReq The message to send.
     */
    function f_sendGeoNetMessage(in template (value) GeoNetworkingReq p_geoNetReq) runs on ItsGeoNetworking {
      geoNetworkingPort.send(p_geoNetReq);
      if (not (ischosen(p_geoNetReq.msgOut.gnPacket.packet.extendedHeader.shbHeader)
               or ischosen(p_geoNetReq.msgOut.gnPacket.packet.extendedHeader.beaconHeader))) {
        f_setLocalSequenceNumber();
      }
    }
        
    /**
     * @desc    Sends a GeoNetworking message with a payload and in case of an included sequence number in the message the
     *          local sequence number will be increased by one.
     * @param   p_geoNetReq The message to send.
     * @param   p_payload   The payload to include.
     */
    function f_sendGeoNetMessageWithPayload(
                                            in template (value) GeoNetworkingReq p_geoNetReq,
                                            in template (value) GnRawPayload p_payload
                                            ) runs on ItsGeoNetworking {
    p_geoNetReq.msgOut.gnPacket.packet.payload := p_payload;
      geoNetworkingPort.send(p_geoNetReq);
      if (not (ischosen(p_geoNetReq.msgOut.gnPacket.packet.extendedHeader.shbHeader)
               or ischosen(p_geoNetReq.msgOut.gnPacket.packet.extendedHeader.beaconHeader))) {
        f_setLocalSequenceNumber();
      }
    }
        
    /**
     * @desc    Receive a GeoNetworking message with a payload and in case of an included sequence number in the message the
     *          local sequence number will be increased by one.
     * @param   p_geoNetInd The message to receive.
     * @param   p_payload   The payload to include.
     */
    function f_receiveGeoNetMessageWithPayload(
                                               in template (present) GeoNetworkingInd p_geoNetInd,
                                               in template (present) GnRawPayload p_payload
                                               ) return template (present) GeoNetworkingInd {
      var template (present) GeoNetworkingInd v_geoNetInd := p_geoNetInd;
            
    v_geoNetInd.msgIn.gnPacket.packet.payload := p_payload;
            
      return v_geoNetInd;
    }
        
    /**
     * @desc    Sets the value of the sequence number for the next event.
     */
    function f_setLocalSequenceNumber() runs on ItsGeoNetworking {
    vc_localSeqNumber := (vc_localSeqNumber + 1) mod c_uInt16Max;
    }
        
    /**
     * @desc    Creates an initial seqence number
     * @return  Time based initial sequence number (increasing with time)
     */
    function f_getInitialSequenceNumber() return UInt16 {
            
      return (f_computeGnTimestamp() / 1000) mod c_uInt16Max;
    }
        
    /**
     * @desc    Number of messages to be sent
     * @return  Number of messages to be sent
     */
    function f_getMessageCount() return integer {
      return PX_MESSAGE_COUNT;
    }
        
  } // End of group testerFunctions
garciay's avatar
garciay committed
    
  group iutFunctions {
        
    /**
     * @desc    Gets the IUT GN local address
     * @return  IUT's GN_Address
     * @see     PICS_GN_LOCAL_GN_ADDR
     */
    function f_getIutGnLocalAddress() return GN_Address {
            
      return PICS_GN_LOCAL_GN_ADDR;
    }
        
    /**
     * @desc    Gets the IUT GN local address configuration method
     * @return  GnAddressConfigurationMethod - IUT's GN local address configuration method
     * @see     PICS_GN_LOCAL_ADDR_CONF_METHOD
     */
    function f_getIutGnLocalAddressConfigurationMethod() return GnAddressConfigurationMethod {
      return PICS_GN_LOCAL_ADDR_CONF_METHOD;
    }
        
    /**
     * @desc    Gets the IUT MAc address
     * @return  MacAddress - IUT's MAc Address
     * @see     PICS_IUT_MAC_ADDRESS
     */
    function f_getIutMacAddress() return MacAddress {
      return PICS_IUT_MAC_ADDRESS;
    }
        
    /**
     * @desc    Gets the GeoUnicast forwarding algorithm
     * @return  IUT's GeoUnicast forwarding algorithm
         * @see     PICS_GN_NON_AREA_FORWARDING_ALGORITHM
garciay's avatar
garciay committed
     */
        function f_getNonAreaForwardingAlgorithm() return NonAreaForwardingAlgorithm {
            return PICS_GN_NON_AREA_FORWARDING_ALGORITHM;
garciay's avatar
garciay committed
    }
        
    /**
     * @desc    Gets the GeoBroadcast forwarding algorithm
     * @return  IUT's GeoBroadcast forwarding algorithm
         * @see     PICS_GN_AREA_FORWARDING_ALGORITHM
garciay's avatar
garciay committed
     */
        function f_getAreaForwardingAlgorithm() return AreaForwardingAlgorithm {
            return PICS_GN_AREA_FORWARDING_ALGORITHM;
garciay's avatar
garciay committed
    }
        
    /**
     * @desc    Gets the IUT default hop limit
     * @return  IUT's default hop limit
     * @see     PICS_GN_DEFAULT_HOP_LIMIT
     */
    function f_getDefaultHopLimit() return UInt8 {
      return PICS_GN_DEFAULT_HOP_LIMIT;
    }
        
    /**
     * @desc    Is the ITS-S mobile or stationary?
     * @return  Flags indicating whether the ITS-S is mobile or stationary.
     * @see     PICS_GN_IS_MOBILE
     */
    function f_isMobile() return Bit8 {
      if (PICS_GN_IS_MOBILE) {
        return '10000000'B;
      }
      return '00000000'B;
    }
        
    /**
     * @desc    Gets the LS retransmission timer.. Valid for NetRepInterval = default (cong. ctrl).
     * @return  LS retransmission timer in seconds
     * @see     PICS_GN_LOCATION_SERVICE_RETRANSMIT_TIMER
     */
    function f_getLsRetransmitTimer() return float {
      var float v_itsGnLocationServiceRetransmitTimer := int2float(PICS_GN_LOCATION_SERVICE_RETRANSMIT_TIMER/1000);
            
      return v_itsGnLocationServiceRetransmitTimer;
    }
        
    /**
     * @desc    Gets the LS retransmission timer for NetRepInterval = medium (cong. ctrl).
     * @return  LS retransmission timer (medium) in seconds
     * @see     PX_GN_LOCATION_SERVICE_TIMER_MEDIUM
     */
    function f_getLsRetransmitTimerMedium() return float {
      var float v_itsGnLocationServiceRetransmitTimerMedium := int2float(PX_GN_LOCATION_SERVICE_TIMER_MEDIUM/1000);
            
      return v_itsGnLocationServiceRetransmitTimerMedium;
    }
        
    /**
     * @desc    Gets the LS retransmission timer for NetRepInterval = maximum (cong. ctrl).
     * @return  LS retransmission timer (maximum) in seconds
     * @see     PX_GN_LOCATION_SERVICE_TIMER_MAXIMUM
     */
    function f_getLsRetransmitTimerMaximum() return float {
      var float v_itsGnLocationServiceRetransmitTimerMaximum := int2float(PX_GN_LOCATION_SERVICE_TIMER_MAXIMUM/1000);
            
      return v_itsGnLocationServiceRetransmitTimerMaximum;
    }
        
    /**
     * @desc    Gets the App retransmission timer. Valid for AppRepInterval = default (cong. ctrl).
     * @return  App retransmission timer in seconds
     * @see     PX_GN_APPLICATION_RETRANSMIT_TIMER
     */
    function f_getAppRetransmitTimer() return float {
      var float v_itsGnLocationApplicationRetransmitTimer := int2float(PX_GN_APPLICATION_RETRANSMIT_TIMER/1000);
            
      return v_itsGnLocationApplicationRetransmitTimer;
    }
        
    /**
     * @desc    Gets the App retransmission timer for AppRepInterval = medium (cong. ctrl).
     * @return  App retransmission timer (medium) in seconds
     * @see     PX_GN_APPLICATION_RETRANSMIT_TIMER_MEDIUM
     */
    function f_getAppRetransmitTimerMedium() return float {
      var float v_itsGnLocationApplicationRetransmitTimerMedium := int2float(PX_GN_APPLICATION_RETRANSMIT_TIMER_MEDIUM/1000);
            
      return v_itsGnLocationApplicationRetransmitTimerMedium;
    }
        
    /**
     * @desc    Gets the App retransmission timer for AppRepInterval = maximum (cong. ctrl).
     * @return  App retransmission timer (maximum) in seconds
     * @see     PX_GN_APPLICATION_RETRANSMIT_TIMER_MAXIMUM
     */
    function f_getAppRetransmitTimerMaximum() return float {
      var float v_itsGnLocationApplicationRetransmitTimerMaximum := int2float(PX_GN_APPLICATION_RETRANSMIT_TIMER_MAXIMUM/1000);
            
      return v_itsGnLocationApplicationRetransmitTimerMaximum;
    }
        
    /**
     * @desc    Gets the LS maximum retransmission number.
     * @return  LS maximum retransmission number
     * @see     PICS_GN_LOCATION_SERVICE_MAX_RETRANS
     */
    function f_getLsMaxRetrans() return integer {
      var integer v_itsGnLocationServiceMaxRetrans := PICS_GN_LOCATION_SERVICE_MAX_RETRANS;
            
      return v_itsGnLocationServiceMaxRetrans;
    }
        
    /**
     * @desc    Gets the Application maximum retransmission number.
     * @return  Application maximum retransmission number
     * @see     PX_GN_APPLICATION_MAX_RETRANS
     */
    function f_getAppMaxRetrans() return integer {
      var integer v_itsGnApplicationMaxRetrans := PX_GN_APPLICATION_MAX_RETRANS;
            
      return v_itsGnApplicationMaxRetrans;
    }
        
    /**
     * @desc    Gets the Location Service packet buffer size.
     * @return  Location Service packet buffer size in Kbytes
     * @see     PICS_GN_LOCATION_SERVICE_PACKET_BUFFER_SIZE
     */
    function f_getLsPacketBufferSize() return integer {
      var integer v_itsGnLocationServicePacketBufferSize := PICS_GN_LOCATION_SERVICE_PACKET_BUFFER_SIZE;
            
      return v_itsGnLocationServicePacketBufferSize;
        } // End of function f_getLsPacketBufferSize
garciay's avatar
garciay committed
        
    /**
     * @desc    Gets the UC forwarding packet buffer size.
     * @return  UC forwarding packet buffer size in bytes
     * @see     PICS_GN_UC_FORWARDING_PACKET_BUFFER_SIZE
     */
    function f_getUcForwardingPacketBufferSize() return integer {
      var integer v_itsGnUcForwardingPacketBufferSize := PICS_GN_UC_FORWARDING_PACKET_BUFFER_SIZE;
            
      return v_itsGnUcForwardingPacketBufferSize * 1024;
        } // End of function f_getUcForwardingPacketBufferSize
garciay's avatar
garciay committed
        
    /**
     * @desc    Gets the BC forwarding packet buffer size.
     * @return  BC forwarding packet buffer size in bytes
     * @see     PICS_GN_BC_FORWARDING_PACKET_BUFFER_SIZE
     */
    function f_getBcForwardingPacketBufferSize() return integer {
      var integer v_itsGnBcForwardingPacketBufferSize := PICS_GN_BC_FORWARDING_PACKET_BUFFER_SIZE;
            
      return v_itsGnBcForwardingPacketBufferSize * 1024;
        } // End of function f_getBcForwardingPacketBufferSize
garciay's avatar
garciay committed
        
    /**
     * @desc    Gets the maximum lifetime of a packet.
     * @return  Maximum lifetime of a packet in seconds
     * @see     PICS_GN_MAX_PACKET_LIFETIME
     */
    function f_getMaxPacketLifeTime() return float {
      var float v_itsGnMaxPacketLifetime := int2float(PICS_GN_MAX_PACKET_LIFETIME);
            
      return v_itsGnMaxPacketLifetime;
    }
        
    /**
     * @desc    Gets delta for timers.
     * @return  Delta for timers in seconds
     * @see     PX_T_DELTA
     */
    function f_getDeltaTimer() return float {
      var float v_deltaTimer := PX_T_DELTA;
            
      return v_deltaTimer;
    }
        
    /**
     * @desc Gets the beacon service retransmit timer.
     * @return  Beacon service retransmit timer
     */
    function f_getBsRetransmitTimer() return float {
      var float v_itsGnBeaconServiceRetransmitTimer;
            
    v_itsGnBeaconServiceRetransmitTimer := int2float(
                                                     (PICS_GN_BEACON_SERVICE_RETRANSMIT_TIMER/1000));
            
      return v_itsGnBeaconServiceRetransmitTimer;
    }
        
    /**
     * @desc    Gets the beacon service retransmit timer for NetBeaconInterval = medium (cong. ctrl).
     * @return  Beacon service retransmit timer (medium)
     */
    function f_getBsRetransmitTimerMedium() return float {
      var float v_itsGnBeaconServiceRetransmitTimerMedium; // timer value increased (medium)
            
    v_itsGnBeaconServiceRetransmitTimerMedium := int2float(
                                                           (PX_GN_BEACON_SERVICE_TIMER_MEDIUM+float2int((f_getBsMaxJitter() - 0.0 +1.0)*rnd()) + 0)/1000);
            
      return v_itsGnBeaconServiceRetransmitTimerMedium;
    }
        
    /**
     * @desc    Gets the beacon service retransmit timer for NetBeaconInterval = maximum (cong. ctrl).
     * @return  Beacon service retransmit timer (maximum)
     */
    function f_getBsRetransmitTimerMaximum() return float {
      var float v_itsGnBeaconServiceRetransmitTimerMaximum; // timer value increased (maximum)
            
    v_itsGnBeaconServiceRetransmitTimerMaximum := int2float(
                                                            (PX_GN_BEACON_SERVICE_TIMER_MAXIMUM+float2int((f_getBsMaxJitter() - 0.0 +1.0)*rnd()) + 0)/1000);
            
      return v_itsGnBeaconServiceRetransmitTimerMaximum;
    }
        
    /**
     * @desc    Gets the maximum beacon service jitter.
     * @return  Maximum beacon service jitter
     */
    function f_getBsMaxJitter() return float {
      var float v_itsGnBeaconServiceMaxJitter := int2float(PICS_GN_BEACON_SERVICE_MAX_JITTER)/1000.0;
            
      return v_itsGnBeaconServiceMaxJitter;
    }
        
    /**
     * @desc    Gets the Lifetime of a Location Table Entry.
     * @return  Lifetime of a Location Table Entry in seconds
     * @see     PICS_GN_LIFETIME_LOC_TE
     */
    function f_getLifetimeLocTableEntry() return float {
      var float v_itsGnLifetimeLocTableEntry := int2float(PICS_GN_LIFETIME_LOC_TE);
            
      return v_itsGnLifetimeLocTableEntry;
        } // End of function f_getLifetimeLocTableEntry
garciay's avatar
garciay committed
        
    /**
     * @desc    Gets the maximum communication range for CBF algorithm
     * @return  Maximum communication range for CBF algorithm in meters
     * @see     PICS_GN_DEFAULT_MAX_COMMUNICATION_RANGE
     */
    function f_getCbfMaxCommunicationRange() return integer {
      var integer v_maxCommunicationRange := PICS_GN_DEFAULT_MAX_COMMUNICATION_RANGE;
            
      return v_maxCommunicationRange;
    } // End of function f_getCbfMaxCommunicationRange
garciay's avatar
garciay committed
        
    function f_getCbfMaxTime() return integer {
        var integer v_cbfMaxTime := PICS_GN_CBF_MAX_TIME;
garciay's avatar
garciay committed
            
        return v_cbfMaxTime;
    } // End of function f_getCbfMaxTime
garciay's avatar
garciay committed
        
    function f_getCbfMinTime() return integer {
        var integer v_cbfMinTime := PICS_GN_CBF_MIN_TIME;
garciay's avatar
garciay committed
            
        return v_cbfMinTime;
        } // End of function f_getCbfMinTime
garciay's avatar
garciay committed
        
    function f_getGnMaxAreaSize() return float {
      var float v_maxAreaSize := PICS_GN_MAX_GEO_AREA_SIZE;
            
      return v_maxAreaSize;
        } // End of function f_getGnMaxAreaSize
garciay's avatar
garciay committed
        
    function f_getAdvancedGbcForwardingMaxCounter() return integer {        
      var integer v_maxCounter := PICS_GN_ADVANCED_BC_FORWARDING_MAX_COUNTER;
            
      return v_maxCounter;  
    }
        
    /**
     * @desc    Set the number of neighbour in the Location Table.
     * @see     PX_MIN_NR_NEIGHBOUR
     */
    function f_setNrNeighbourLocTableDefault() runs on ItsGeoNetworking {
      var integer v_nrNeighbour := f_random (0, PX_MIN_NR_NEIGHBOUR);
            
      f_acStartBeaconingMultipleNeighbour(v_nrNeighbour);
            
        } // End of function f_setNrNeighbourLocTableDefault
garciay's avatar
garciay committed
        
    /**
     * @desc    Set the number of neighbour in the Location Table (medium).
     * @see     PX_MIN_NR_NEIGHBOUR
     * @see     PX_MAX_NR_NEIGHBOUR
     */
    function f_setNrNeighbourLocTableMedium() runs on ItsGeoNetworking {
      var integer v_nrNeighbour := f_random (PX_MIN_NR_NEIGHBOUR, PX_MAX_NR_NEIGHBOUR);
            
      f_acStartBeaconingMultipleNeighbour(v_nrNeighbour);
            
        } // End of function f_setNrNeighbourLocTableMedium
garciay's avatar
garciay committed
        
    /**
     * @desc    Set the number of neighbour in the Location Table (maximum).
     * @see     PX_MAX_NR_NEIGHBOUR
     * @see     PX_MIN_NR_NEIGHBOUR
     */
    function f_setNrNeighbourLocTableMaximum() runs on ItsGeoNetworking {
      var integer v_nrNeighbour := f_random (PX_MAX_NR_NEIGHBOUR, (2*PX_MIN_NR_NEIGHBOUR));
            
      f_acStartBeaconingMultipleNeighbour(v_nrNeighbour);
            
        } // End of function f_setNrNeighbourLocTableMaximum
garciay's avatar
garciay committed
                
  } // End of group iutFunctions
garciay's avatar
garciay committed
    
  group posVectorFunctions {
        
    /**
     * @desc    Convert long position vector to short position vector
     * @param   p_longPosVector Long position vector to be converted
     * @return  Short position vector
     */
    function f_longPosVector2ShortPosVector(in LongPosVector p_longPosVector) return ShortPosVector {
      var ShortPosVector v_shortPosVector;
            
    v_shortPosVector := {
      gnAddr := p_longPosVector.gnAddr,
      timestamp_ := p_longPosVector.timestamp_,
      latitude := p_longPosVector.latitude,
      longitude := p_longPosVector.longitude
    };
            
      return v_shortPosVector;
    }
        
    /**
     * @desc    Get IUT's long position vector
     * @return  IUT's long position vector
     */
    function f_getIutLongPosVector() runs on ItsBaseGeoNetworking return LongPosVector {
      return f_acGetLongPosVector(f_getIutGnLocalAddress());
    }
    function f_getIutLongPosVector_1(inout LongPosVector p_longPosVectorIut) runs on ItsGeoNetworking {
      p_longPosVectorIut := f_acGetLongPosVector(f_getIutGnLocalAddress());
    }
    
    /**
     * @desc    Get IUT's short position vector
     * @return  IUT's short position vector
     */
    function f_getIutShortPosVector() runs on ItsGeoNetworking return ShortPosVector {
      var LongPosVector v_longPosVectorIut := f_getPosition(c_compIut);
            
      if (not isbound(v_longPosVectorIut)) {
      v_longPosVectorIut := f_getIutLongPosVector();
      }
      return f_longPosVector2ShortPosVector(v_longPosVectorIut);
    }
        
    /**
     * @desc    Compute a position using a reference position, a distance and an orientation
     * @param   p_iutLongPosVector Reference position
     * @param   p_distance Distance to the reference position (in meter)
     * @param   p_orientation direction of the computed position (0 to 359; 0 means North)
     * @return  LongPosVector
     */
    function f_computePositionUsingDistance(in LongPosVector p_iutLongPosVector, in float p_distance, in integer p_orientation)
    return LongPosVector {
      var LongPosVector v_result := p_iutLongPosVector;
            
      log("*** f_computePositionUsingDistance: INFO: calling fx_computePositionUsingDistance() ***");
      fx_computePositionUsingDistance(p_iutLongPosVector.latitude, p_iutLongPosVector.longitude, p_distance, p_orientation, v_result.latitude, v_result.longitude);
            
      return v_result;
    }
        
  } // End of group posVectorFunctions
garciay's avatar
garciay committed
    
  group externalFunctions {
        
    /**
     * @desc    External function to compute timestamp based on current time
     * @return  Unix-Epoch-Time mod 2^32
     */
    external function fx_computeGnTimestamp() return UInt32;
        
  } // End of group externalFunctions
    
  group security {
        
    /**
     * @desc    Waiting for the GN message with Security
     * @param   p_InSecMsg  SecurityMessage template 
     * @param   p_received  returns received SecurityMessage 
     */
    altstep a_securedMessage (
                              in template (present) EtsiTs103097Data p_InSecMsg,
                              out EtsiTs103097Data p_received
                              ) runs on ItsGeoNetworking {
      var GeoNetworkingInd v_geoNw;
      [] geoNetworkingPort.receive(mw_geoNwInd(
                                               mw_geoNwSecPdu(
                                                              p_InSecMsg,
                                                              mw_geoNwAnyPacket_withPayload(?)
                                                              ))) -> value v_geoNw {
      p_received := f_getSecuredMessage(v_geoNw.msgIn);
      }
    } // End of 'altstep' statement
        
    /**
     * @desc         Receive GN message with security containing certificate as a signer info
     * @param p_cert returns the certificate used for sign received message
     */
    altstep a_securedMessageWithCertificate(
                                            out EtsiTs103097Data p_received
                                            ) runs on ItsGeoNetworking {
            
      [] a_securedMessage (
                            mw_etsiTs103097Data_signed(
                                mw_signedData(
                                    -, 
                                    mw_toBeSignedData(
                                        mw_signedDataPayload
                                    ),
                                    mw_signerIdentifier_certificate // containing certificate
                                )
                            ), 
                            p_received
                           ) {
        // Nothing to do
      }
    } // End of 'altstep' a_securedMessageWithCertificate
garciay's avatar
garciay committed

    /**
     * @desc         Receive GN message with security containing digest as a signer info
     * @param p_cert returns the certificate used for sign received message
     */
    altstep a_securedMessageWithDigest(
                                       out EtsiTs103097Data p_received
                                       ) runs on ItsGeoNetworking {
      [] a_securedMessage (
                            mw_etsiTs103097Data_signed(
                                mw_signedData(
                                    -, 
                                    mw_toBeSignedData(
                                        mw_signedDataPayload
                                    ),
                                    mw_signerIdentifier_digest // containing digest
                                )
                            ), 
                            p_received
                           ) {
        // Nothing to do
      }
    } // End of altstep a_securedMessageWithDigest
        
  } // End of group altSteps
    
  group waitingHelpers {
        
    /**
     * @desc  Wait for GN message with security containing certificate as a signer info
     * @return the certificate used for sign received message
     */
    function f_waitForCertificate(
                                  out EtsiTs103097Certificate p_cert
                                  ) runs on ItsGeoNetworking return boolean {
      var EtsiTs103097Data v_recv;
      var boolean v_ret := false;
            
      alt {
        [] a_securedMessageWithCertificate(v_recv) {
          var SignerIdentifier v_signerIdentifier;
          if (f_getMsgSignerIdentifier(v_recv, v_signerIdentifier) == true) { 
            if (ischosen(v_signerIdentifier.certificate)) {
              p_cert :=  v_signerIdentifier.certificate[0];
              v_ret := true;
            }
          }
        }
      } // End of 'alt' statement
            
      return v_ret;
    } // End of function f_waitForCertificate
        
    /**
     * @desc  Ask for the certificate chain and wait for GN message with security containing certificate chain as a signer info
     * @return the certificate chain used for sign received message
     */
        function f_askForCertificateChain(
                                          in template(value) octetstring p_CamPayload
        ) runs on ItsGeoNetworking return boolean {
garciay's avatar
garciay committed
      var EtsiTs103097Data v_recv;
      var boolean v_ret := false;
        
      alt {
        [] a_securedMessageWithCertificate(v_recv) {
          var SignerIdentifier v_signerIdentifier;
          if (f_getMsgSignerIdentifier(v_recv, v_signerIdentifier) == true) { // Get AT certificate
            if(ischosen(v_signerIdentifier.digest)) {
              f_sendCertificateRequest(v_signerIdentifier.digest, p_CamPayload); // Request issuer
              if(tc_ac.running) {
                tc_ac.stop;
                tc_ac.start;
              }
              v_ret := true;
            }
          }
        }
      }
      return v_ret;
    } // End of function f_askForCertificateChain
      
    /**
     * @desc  Ask for the certificate chain and wait for GN message with security containing certificate chain as a signer info
     * @return the certificate chain used for sign received message
     */
    function f_askAndWaitForCertificateChain(
                                             out SequenceOfCertificate p_chain, 
                                             in template(value) octetstring p_CamPayload
                                             ) runs on ItsGeoNetworking return boolean {
      // Local variables
      var EtsiTs103097Data v_recv;
      var SignerIdentifier v_signerIdentifier;
      var boolean v_ret := false;
      
      f_askForCertificateChain(p_CamPayload); // Get AT certificate and request for the issuer
      alt {
        [] a_securedMessageWithCertificate(v_recv) { // Get AA certificate
          tc_ac.stop;
          
          if (f_getMsgSignerIdentifier(v_recv, v_signerIdentifier) == true) { 
            p_chain := v_signerIdentifier.certificate;
          }
        }
      } // End of 'alt' statement
            
      return v_ret;
    } // End of function f_askAndWaitForCertificateChain
        
    /**
     * @desc Send a CAM message with a certificate and wait the certificate chain request message
     * @remark  This function is used only for testing against another ATS
     * @param p_certificate The certificate identifier
     * @param p_CamPayload  The CAM paylaod
     * @return true on success, flase otherwise
     */
    function f_sendCertificateAndWaitForCertificateChainRequest(
                                                                in charstring p_certificate, 
                                                                in template(value) octetstring p_CamPayload
                                                                ) runs on ItsGeoNetworking return boolean {
      // Local variables
      var EtsiTs103097Data v_recv;
            
      f_sendCertificate(p_certificate, p_CamPayload);
      /* FIXME To be reviewed alt {
        [] a_securedMessage (
                             mw_securedMessage(
                                                superset(
                                                         mw_header_field_unrecognised_certificate
                                                         )),
                             v_recv
                             ) {
          // Nothing to do
          log("*** " & testcasename() & ": DEBUG: Receive certificate ***")
          }
      }*/ // End of 'alt' statement
            
      return true;
    } // End of function f_sendCertificateAndWaitForCertificateChainRequest
        
  } // End of group waitingHelpers
        
  group CertRequests{
        
    function f_sendCertificateRequest(
                                      in template (value) HashedId8 p_digest,
                                      in template (value) octetstring p_payload
                                      ) runs on ItsGeoNetworking {
      var GeoNetworkingReq v_gnReq;
      var GnNonSecuredPacket v_gnNonSecuredPacket;
      var template (value) ToBeSignedData v_toBeSignedData;
      var template (value) EtsiTs103097Data v_securedMessage;
                
      // Build signed EtsiTs103097Data
    v_gnNonSecuredPacket := valueof(m_geoNwShbPacket(
                                                     f_getPosition(c_compNodeC) // FIXME To be verified YANN
                                                     ));
      // Add CAM payload
    v_gnNonSecuredPacket.payload := valueof(p_payload);
            
      /* FIXME To be reviewed f_buildGnSecuredCam(
                          v_securedMessage,
                          m_payload_signed(bit2oct(encvalue(v_gnNonSecuredPacket))),
                          e_certificate,
                          { 
                            m_header_field_unrecognised_certificate(
                                                                    f_HashedId3FromHashedId8(
                                                                                             valueof(p_digest)
                                                                                             )) 
                            },
                          ""
                          );
                
      // Build secured Gn packet
    v_gnReq := valueof(m_geoNwReq_linkLayerBroadcast(
                                                     m_geoNwSecPdu(
                                                                   v_gnNonSecuredPacket,
                                                                   v_securedMessage
garciay's avatar
garciay committed
                                                     )); // End of template m_geoNwReq_linkLayerBroadcast
            
      // Send Message
      f_sendGeoNetMessage(v_gnReq);*/
            
    } // End of function f_sendCertificateRequest
        
    /**
     * @desc Send a CAM message with a certificate
     * @remark  This function is used only for testing against another ATS
     * @param p_certificate The certificate identifier
     * @param p_CamPayload  The CAM paylaod
     * @return true on success, flase otherwise
     * @see     f_sendCertificateAndWaitForCertificateChainRequest
     */
    function f_sendCertificate(
                               in charstring p_certificate,
                               in template (value) octetstring p_payload
                               ) runs on ItsGeoNetworking {
      var GeoNetworkingReq v_gnReq;
      var GnNonSecuredPacket v_gnNonSecuredPacket;
      var template (value) ToBeSignedData v_toBeSignedData;
      var template (value) EtsiTs103097Data v_securedMessage;
                
      // Build signed EtsiTs103097Data
    /* FIXME To be reviewed v_gnNonSecuredPacket := valueof(m_geoNwShbPacket(
                                                     f_getPosition(c_compNodeC) // FIXME To be verified YANN
                                                     ));
      // Add CAM payload
    v_gnNonSecuredPacket.payload := valueof(p_payload);
            
      f_buildGnSecuredCam(
                          v_securedMessage,
                          m_payload_signed(bit2oct(encvalue(v_gnNonSecuredPacket))),
                          e_certificate,
                          -,
                          p_certificate
                          );
                
      // Build secured Gn packet
    v_gnReq := valueof(m_geoNwReq_linkLayerBroadcast(
                                                     m_geoNwSecPdu(
                                                                   v_gnNonSecuredPacket,
                                                                   v_securedMessage
                                                                   ) // End of template m_geoNwSecPdu
                                                     )); // End of template m_geoNwReq_linkLayerBroadcast
            
      // Send Message
      f_sendGeoNetMessage(v_gnReq);*/
            
    } // End of function f_sendCertificate
        
  } // End of group CertRequests 
    
  group messageGetters {
        
    /**
     * @desc    return EtsiTs103097Data field of GeoNetworking packet 
     * @param   p_msg GeoNetworking packet
     * @return  the EtsiTs103097Data if any
     */
        function f_getSecuredMessage(
                                     in GeoNetworkingPdu p_msg
        ) return EtsiTs103097Data {
garciay's avatar
garciay committed
      return p_msg.gnPacket.securedMsg;
    }
        
  }
    
} // End of module LibItsGeoNetworking_Functions