LibItsGeoNetworking_TypesAndValues.ttcn 35.9 KB
Newer Older
garciay's avatar
garciay committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828
/**
 *  @author     ETSI / STF405 / STF449 / STF484 / STF517
 *  @version    $Url: https://oldforge.etsi.org/svn/LibIts/tags/20170222_STF527_Final/ttcn/GeoNetworking/LibItsGeoNetworking_TypesAndValues.ttcn $
 *              $Id: LibItsGeoNetworking_TypesAndValues.ttcn,v 1.5 2018/06/26 13:54:21 dte Exp $
 *  @desc       Module containing types and values for GeoNetworking Protocol
 *  @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_TypesAndValues {
    
  // LibCommon
  import from LibCommon_BasicTypesAndValues all;
  import from LibCommon_DataStrings all;
    
  // LibIts
  import from EtsiTs103097Module language "ASN.1:1997" all;
    
  group geoConfigurationValues {
        
    const charstring c_compIut := "IUT";
    const charstring c_compMTC := "MTC";
    const charstring c_compNodeA := "NodeA";
    const charstring c_compNodeB := "NodeB";
    const charstring c_compNodeC := "NodeC";
    const charstring c_compNodeD := "NodeD";
    const charstring c_compNodeE := "NodeE";
    const charstring c_compNodeF := "NodeF";
        
    const charstring c_area1 := "AREA1";
    const charstring c_area2 := "AREA2";
        
    const integer c_latitudeFactorNodeA := 10;
    const integer c_latitudeFactorNodeB := 2;
    const integer c_latitudeFactorNodeC := -6;
    const integer c_latitudeFactorNodeD := 1;
    const integer c_latitudeFactorNodeE := -1;
    const integer c_latitudeFactorNodeF := 2;
    const integer c_longitudeFactorNodeA := 0;
    const integer c_longitudeFactorNodeB := 0;
    const integer c_longitudeFactorNodeC := 0;
    const integer c_longitudeFactorNodeD := 0;
    const integer c_longitudeFactorNodeE := 0;
    const integer c_longitudeFactorNodeF := -3;
  } // end geoConfigurationValues
    
  group geoSyncMessages {
        
    const charstring c_msgSent := "Message sent";
        
  } // end geoSyncMessages
    
  group geoTestingConstants {
        
    const UInt6 c_defaultLifetime := 10; // in seconds
    const UInt16 c_lifetime := 1000 * c_defaultLifetime; // in seconds
        
  } // end geoTestingConstants
    
  group units {
        
    const float c_squareKm := 1000000.0;
        
  } // end units
    
  group geoConfigurationTypes {
        
    /**
     * @desc    Entry of position table
     * @member  key         Reference key of the entry
     * @member  position    Position vector stored in the entry
     */
    type record PositionEntry {
      charstring key,
      LongPosVector position
      }
        
    /**
     * @desc    Table containing node positions
     */
    type record of PositionEntry PositionTable;
        
    /**
     * @desc    Parameters of a geometric area
     * @member  geoAreaPosLatitude  Latitude of area's center
     * @member  geoAreaPosLongitude Longitude of area's center
     * @member  distanceA           Distance A
     * @member  distanceB           Distance B
     * @member  angle               Angle
     */
    type record Area {
      Int32  geoAreaPosLatitude,
      Int32  geoAreaPosLongitude,
      UInt16 distanceA,
      UInt16 distanceB,
      UInt16 angle
      }
        
    /**
     * @desc    Compact definition of GeoBroadcastArea
     * @member  geoBroadcastSubType Type of GeoBroadcastArea (=shape)
     * @member  geoBroadcastArea    Parameters of the geometric area
     */
    type record GeoBroadcastArea {
      HeaderSubTypeGeoBroadcast geoBroadcastSubType,
      Area geoBroadcastArea
      }
        
    /**
     * @desc    Compact definition of GeoAnycastArea
     * @member  geoAnycastSubType   Type of GeoAnycastArea (=shape)
     * @member  geoAnycastArea      Parameters of the geometric area
     */
    type record GeoAnycastArea {
      HeaderSubTypeGeoAnycast geoAnycastSubType,
      Area geoAnycastArea
      }
        
    /**
     * @desc    Compact definition of a GeoArea (either GeoBroadcastArea or GeoAnycastArea)
     * @member  shape   Shape of the GeoArea
     * @member  area    Parameters of the geometric area
     */
    type record GeoArea {
      GeoShape shape,
      Area area
      }
        
    /**
     * @desc    Geometric shapes used to define GeoAreas
     */
    type enumerated GeoShape {
      e_geoCircle(0),
      e_geoRect(1),
      e_geoElip(2),
      e_reserved
      }
        
    /**
     * @desc    Entry of GeoArea table
     * @member  key     Reference key of the entry
     * @member  geoArea GeoArea stored in the entry
     */
    type record GeoAreaEntry {
      charstring key,
      GeoArea geoArea
      }
        
    /**
     * @desc    Table containing geoArea definitions
     */
    type record of GeoAreaEntry GeoAreaTable;
        
  } // end geoConfigurationTypes
    
  group geoNwValues {
        
    group geoNwHeaderConstants {
            
      const UInt4 c_geoNwProtocolVersion := 1;
            
      const UInt8 c_hopLimit1 := 1;
      const UInt8 c_defaultHopLimit := 10;
            
    } // end geoNwHeaderConstants
        
  } // end geoNwValues
    
  group geoNetworkingPdus {
        
    /**
     * @desc GeoNetworking Packet
     *
     * @see ETSI EN 302 636-4-1 chapter 8.2, 8.3, 8.4
     *
     * @member basicHeader
     * @member gnPacket
     */
    type record GeoNetworkingPdu {
      BasicHeader         basicHeader,
      GeoNetworkingPacket gnPacket
      }
        
    type record GeoNetworkingPacket {
      GnNonSecuredPacket  packet,
      EtsiTs103097Data    securedMsg optional
    } with {
      encode (securedMsg) "LibItsSecurity"
    }
        
    type octetstring GnRawPayload;
        
    type record GnNonSecuredPacket {
      CommonHeader    commonHeader,
      ExtendedHeader  extendedHeader optional,
      GnRawPayload    payload optional
      }        
  } // end group geoNetworkingPdus
    
  group geoNetworkingHeader {
        
    group geoNetworkingBasicHeader {
            
      /**
       * @desc Basic Header
       *
       * <pre>
       *  0               1               2               3
       *  0 1 2 3 4 5 6 7 0 1 2 3 4 5 6 7 0 1 2 3 4 5 6 7 0 1 2 3 4 5 6 7
       * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
       * |   V   |  NH   |    Reserved   |      LT       |      RHL      |
       * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
       * </pre>
       *
       * @see ETSI EN 302 636-4-1 chapter 8.6.1
       *
       * @member version
       * @member nextHeader
       * @member reserved
       * @member lifeTime
       * @member routerHopLimit
       */
      type record BasicHeader {
        UInt4           version,
        BasicNextHeader nextHeader,
        UInt8           reserved,
        Lifetime        lifeTime,
        UInt8           routerHopLimit
      } with {
        variant "FIELDORDER(msb)"
      }
            
      type enumerated BasicNextHeader {
        e_any(0),
        e_commonHeader(1),
        e_securedPacket(2),
        e_reserved
        } with {
        variant "FIELDLENGTH(4)"
        }
            
      /**
       * @desc Indicates the maximum tolerable time a packet can be buffered until it reaches its destination.
       * @member multiplier
       * @member ltBase
       */
      type record Lifetime {
        UInt6   multiplier,
        LtBase  ltBase
      } with {
        variant "FIELDORDER(msb)"
      }
            
      /**
       * @desc The base for the calculation of the lifetime.
       */
      type enumerated LtBase {
        e_50ms(0),
        e_1s(1),
        e_10s(2),
        e_100s(3)
      } with {
        variant "FIELDLENGTH(2)"
      }
            
    } // end group geoNetworkingBasicHeader
        
    group geoNetworkingCommonHeader {
            
      /**
       * @desc Common header for GeoNetworking
       *
       * <pre>
       *  0               1               2               3
       *  0 1 2 3 4 5 6 7 0 1 2 3 4 5 6 7 0 1 2 3 4 5 6 7 0 1 2 3 4 5 6 7
       * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
       * |  NH   |   R   |  HT   |  HST  |      TC       |     Flags     |
       * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
       * |              PL               |     MHL       |    Reserved   |
       * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
       * </pre>
       *
       * @see ETSI EN 302 636-4-1 chapter 8.7.2
       *
       * @member nextHeader
       * @member reserved
       * @member headerTST Header type + Header Sub Type
       * @member trafficClass
       * @member flags
       * @member plLength
       * @member maxHopLimit
       * @member reserved2
       */
      type record CommonHeader {
        NextHeader      nextHeader,
        UInt4           reserved,
        HeaderTST       headerTST,
        TrafficClass    trafficClass,
        Bit8            flags,
        UInt16          plLength, // The Codec shall set the length of the paylaod if present
        UInt8           maxHopLimit,
        UInt8           reserved2
      } with {
        variant "FIELDORDER(msb)"
      }
            
      /**
       * @desc Identifies the type of header immediately following the Common Header (4Bits).
       */
      type enumerated NextHeader {
        e_any(0),
        e_btpA(1),
        e_btpB(2),
        e_ipv6(3),
        e_reserved
      } with {
        variant "FIELDLENGTH(4)" //variant "4 bit"
      }
            
      /**
       * @desc TrafficClass
       *
       * <pre>
       *  0   1   2   3   4   5   6   7
       * +---+---+---+---+---+---+---+---+
       * |SCF|Ch.|         TC ID         |
       * |   |Off|                       |
       * +---+---+---+---+---+---+---+---+
       * </pre>
       *
       * @see ETSI EN 302 636-4-1 chapter 8.7.5
       *
       * @member scf
       * @member channelOffload
       * @member tcId
       */
      type record TrafficClass {
        SCF                     scf,
        ChannelOffload          channelOffload,
        TcId                    tcId
      } with { 
        variant "FIELDORDER(msb)" 
      }
            
      type enumerated SCF {
        e_scfDisabled(0),
        e_scfEnabled (1)
      } with {
        variant "FIELDLENGTH(1)" //variant "1 bit"
      }
      type enumerated ChannelOffload {
        e_choffDisabled(0),
        e_choffEnable (1)
      } with {
        variant "FIELDLENGTH(1)" //variant "1 bit"
      }
      type UInt6 TcId;
            
    } // end group geoNetworkingCommonHeader
        
    group geoNetworkingExtendedHeaders {
            
      /**
       * @desc GeoNetworking ExtendedHeader
       *
       * @see ETSI EN 302 636-4-1 chapter 8.3
       *
       * @member commonHeader
       * @member gnExtHeader
       */
      type union ExtendedHeader {
        GeoUnicastHeader    geoUnicastHeader,
          TSBHeader           tsbHeader,
          SHBHeader           shbHeader,
          GeoBroadcastHeader  geoBroadcastHeader,
          GeoAnycastHeader    geoAnycastHeader,
          BeaconHeader        beaconHeader,
          LSRequestHeader     lsRequestHeader,
          LSReplyHeader       lsReplyHeader,
          AnyHeader           anyHeader
      } with {
        variant ""
      }
            
      /**
       * @desc The unspecified ANY header.
       *
       * @member seqNumber
       * @member reserved
       */
      type record AnyHeader {
        UInt16          seqNumber,
        UInt16          reserved
      } with {
        variant "FIELDORDER(msb)"
      }
            
      /**
       * @desc The BEACON packet header.
       *
       * @see ETSI EN 302 636-4-1 chapter 8.8.6
       *
       * @member commonHeader
       */
      type record BeaconHeader {
        LongPosVector   srcPosVector
      } with {
        variant "FIELDORDER(msb)"
      }
            
      /**
       * @desc The GEOANYCAST packet header.
       *
       * @see ETSI EN 302 636-4-1 chapter 8.8.5
       *
       * @member seqNumber
       * @member reserved
       * @member srcPosVector
       * @member geoAreaPosLatitude
       * @member geoAreaPosLongitude
       * @member distanceA
       * @member distanceB
       * @member angle
       * @member reserved
       */
      type record GeoAnycastHeader {
        UInt16          seqNumber,
        UInt16          reserved,
        LongPosVector   srcPosVector,
        Int32           geoAreaPosLatitude,
        Int32           geoAreaPosLongitude,
        UInt16          distanceA,
        UInt16          distanceB,
        UInt16          angle,
        UInt16          reserved2
      } with {
        variant "FIELDORDER(msb)"
      }
            
      /**
       * @desc The GEOBROADCAST packet header.
       *
       * @see ETSI EN 302 636-4-1 chapter 8.8.5
       *
       * @member seqNumber
       * @member reserved
       * @member srcPosVector
       * @member geoAreaPosLatitude
       * @member geoAreaPosLongitude
       * @member distanceA
       * @member distanceB
       * @member angle
       * @member reserved
       */
      type GeoAnycastHeader GeoBroadcastHeader;
            
      /**
       * @desc The GEOUNICAST packet header.
       *
       * @see ETSI EN 302 636-4-1 chapter 8.8.2
       *
       * @member seqNumber
       * @member reserved
       * @member srcPosVector
       * @member dstPosVector
       */
      type record GeoUnicastHeader {
        UInt16          seqNumber,
        UInt16          reserved,
        LongPosVector   srcPosVector,
        ShortPosVector  dstPosVector
      } with {
        variant "FIELDORDER(msb)"
      }
            
      /**
       * @desc The Location Service (LS) Reply packet header.
       *
       * @see ETSI EN 302 636-4-1 chapter 8.8.8
       *
       * @member seqNumber
       * @member reserved
       * @member srcPosVector
       * @member dstPosVector
       */
      type record LSReplyHeader {
        UInt16          seqNumber,
        UInt16          reserved,
        LongPosVector   srcPosVector,
        ShortPosVector  dstPosVector
      } with {
        variant "FIELDORDER(msb)"
      }
            
      /**
       * @desc The Location Service (LS) Request packet header.
       *
       * @see ETSI EN 302 636-4-1 chapter 8.8.7
       *
       * @member seqNumber
       * @member reserved
       * @member srcPosVector
       * @member gnAddress
       */
      type record LSRequestHeader {
        UInt16          seqNumber,
        UInt16          reserved,
        LongPosVector   srcPosVector,
        GN_Address      gnAddress
      } with {
        variant "FIELDORDER(msb)"
      }
            
      /**
       * The Single Hop Broadcast (SHB) packet header.
       *
       * @see ETSI EN 302 636-4-1 chapter 8.8.4
       *
       * @member srcPosVector
       * @member reserved
       */
      type record SHBHeader {
        LongPosVector   srcPosVector,
        UInt32          reserved
      } with {
        variant "FIELDORDER(msb)"
      }
            
      /**
       * @desc The Topologically-Scoped Broadcast (TSB) packet header.
       *
       * @see ETSI EN 302 636-4-1 chapter 8.8.3
       *
       * @member seqNumber
       * @member reserved
       * @member srcPosVector
       */
      type record TSBHeader {
        UInt16          seqNumber,
        UInt16          reserved,
        LongPosVector   srcPosVector
      } with {
        variant "FIELDORDER(msb)"
      }
            
      group geoNetworkingHeadersSubtypes {
                
        /**
         * @desc Identifies the header type and the header subtype for ANY.
         * @member headerType
         * @member reserved
         */
        type record AnyHeaderType {
          HeaderType  headerType(e_any),
          UInt4       headerSubType
        } with { 
          variant "FIELDORDER(msb)" 
        }
                
        /**
         * @desc Identifies the header type and the header subtype for BEACON.
         * @member headerType
         * @member reserved
         */
        type record BeaconHeaderType {
          HeaderType  headerType(e_beacon),
          UInt4       headerSubType
        } with { 
          variant "FIELDORDER(msb)" 
        }
                
        /**
         * @desc Identifies the header type and the header subtype for GEOANYCAST.
         * @member headerType
         * @member reserved
         */
        type record GeoAnycastHeaderType {
          HeaderType              headerType(e_geoAnycast),
          HeaderSubTypeGeoAnycast headerSubType
        } with { 
          variant "FIELDORDER(msb)" 
        }
                
        /**
         * @desc Identifies the header type and the header subtype for GEOBROADCAST.
         * @member headerType
         * @member reserved
         */
        type record GeoBroadcastHeaderType {
          HeaderType                  headerType(e_geoBroadcast),
          HeaderSubTypeGeoBroadcast   headerSubType
        } with { 
          variant "FIELDORDER(msb)" 
        }
                
        /**
         * @desc Identifies the header type and the header subtype for GEOUNICAST.
         * @member headerType
         * @member reserved
         */
        type record GeoUnicastHeaderType {
          HeaderType  headerType(e_geoUnicast),
          UInt4       headerSubType
        } with { 
          variant "FIELDORDER(msb)" 
        }
                
        /**
         * @desc Identifies the header type and the header subtype for Location Service LS.
         * @member headerType
         * @member reserved
         */
        type record LsHeaderType {
          HeaderType      headerType(e_locationService),
          HeaderSubTypeLs headerSubType
        } with { 
          variant "FIELDORDER(msb)" 
        }
                
        /**
         * @desc Identifies the header type and the header subtype for Topologically-Scoped Broadcast TSB.
         * @member headerType
         * @member headerSubType
         */
        type record TsbHeaderType {
          HeaderType       headerType(e_topologicallyScopedBroadcast),
          HeaderSubTypeTSB headerSubType
        } with { 
          variant "FIELDORDER(msb)" 
        }
                
        /**
         * @desc Identifies the header subtype for GEOANYCAST.
         */
        type enumerated HeaderSubTypeGeoAnycast {
          e_geoAnycastCircle(0),
          e_geoAnycastRect(1),
          e_geoAnycastElip(2),
          e_reserved
        } with {
          variant "FIELDLENGTH(4)" //variant "4 bit"
        }
                
        /**
         * @desc Identifies the header subtype for GEOBROADCAST.
         */
        type enumerated HeaderSubTypeGeoBroadcast {
          e_geoBroadcastCircle(0),
          e_geoBroadcastRect(1),
          e_geoBroadcastElip(2),
          e_reserved
        } with {
          variant "FIELDLENGTH(4)" //variant "4 bit"
        }
                
        /**
         * @desc Identifies the header subtype for Topologically-scoped broadcast TSB.
         */
        type enumerated HeaderSubTypeTSB {
          e_singleHop(0),
          e_multiHop(1),
          e_reserved
        } with {
          variant "FIELDLENGTH(4)" //variant "4 bit"
        }
                
        /**
         * @desc Identifies the header subtype for Location Service LS.
         */
        type enumerated HeaderSubTypeLs {
          e_lsRequest(0),
          e_lsReply(1),
          e_reserved
        } with {
          variant "FIELDLENGTH(4)" //variant "4 bit"
        }
                
        /**
         * @desc Identifies the header subtype for Service Announcement SA.
         */
        type enumerated HeaderSubTypeSa {
          e_sa(0),
          e_saEos(1),
          e_reserved
        } with {
          variant "FIELDLENGTH(4)" //variant "4 bit"
        }
                
        /**
         * @desc Identifies the header type and the header subtype.
         * @member anyHdr
         * @member beaconHdr
         * @member geoUnicastHdr
         * @member geoAnycastHdr
         * @member geoBroadcastHdr
         * @member tsbHdr
         * @member lsHdr
         * @member saHdr
         * @member reserved
         */
        type union HeaderTST {
          AnyHeaderType           anyHdr,
            BeaconHeaderType        beaconHdr,
            GeoUnicastHeaderType    geoUnicastHdr,
            GeoAnycastHeaderType    geoAnycastHdr,
            GeoBroadcastHeaderType  geoBroadcastHdr,
            TsbHeaderType           tsbHdr,
            LsHeaderType            lsHdr,
            UInt8                   reserved
        } with { 
          variant "FIELDORDER(msb)" 
        }
                
        /**
         * @desc Identifies the type of the GeoAdhoc header type (4Bits).
         */
        type enumerated HeaderType {
          e_any(0),
          e_beacon(1),
          e_geoUnicast(2),
          e_geoAnycast(3),
          e_geoBroadcast(4),
          e_topologicallyScopedBroadcast(5),
          e_locationService(6),
          e_reserved
        } with {
          variant "FIELDLENGTH(4)" //variant "4 bit"
        }
                
        /**
         * @desc Long Position Vector
         *
         * <pre>
         *  0               1               2               3
         *  0 1 2 3 4 5 6 7 0 1 2 3 4 5 6 7 0 1 2 3 4 5 6 7 0 1 2 3 4 5 6 7
         * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
         * |                           GN_ADDR                             |
         * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
         * |                             TST                               |
         * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
         * |                             Lat                               |
         * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
         * |                             Long                              |
         * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
         * |P|              S              |               H               |
         * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
         * </pre>
         *
         * @see ETSI EN 302 636-4-1 chapter 8.5.2
         *
         * @member gnAddr
         * @member timestamp_
         * @member latitude
         * @member longitude
         * @member pai Position Accuracy Indicator
         * @member speed
         * @member heading
         */
        type record LongPosVector {
          GN_Address  gnAddr,
          UInt32      timestamp_,
          Int32       latitude,
          Int32       longitude,
          Bit1        pai,
          Int15       speed,
          UInt16      heading
        } with { 
          variant "FIELDORDER(msb)" 
        }
                
        /**
         * @desc Short Position Vector
         *
         * <pre>
         *  0               1               2               3
         *  0 1 2 3 4 5 6 7 0 1 2 3 4 5 6 7 0 1 2 3 4 5 6 7 0 1 2 3 4 5 6 7
         * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
         * |                           GN_ADDR                             |
         * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
         * |                             TST                               |
         * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
         * |                             Lat                               |
         * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
         * |                             Long                              |
         * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
         * </pre>
         *
         * @see ETSI EN 302 636-4-1 chapter 8.5.3
         *
         * @member gnAddr
         * @member timestamp
         * @member latitude
         * @member longitude
         */
        type record ShortPosVector {
          GN_Address  gnAddr,
          UInt32      timestamp_,
          Int32       latitude,
          Int32       longitude
        } with { 
          variant "FIELDORDER(msb)" 
        }
                
        group geoNetworkingAddress {
          /**
           * @desc GeoNetworking address
           *
           * <pre>
           *  0               1               2               3
           *  0 1 2 3 4 5 6 7 0 1 2 3 4 5 6 7 0 1 2 3 4 5 6 7 0 1 2 3 4 5 6 7
           * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
           * |M|  S_T    |       S_CC        |             M_ID              |
           * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
           * |                              M_ID                             |
           * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
           * </pre>
           *
           * @see ETSI EN 302 636-4-1 chapter 6.2
           *
           * @member typeOfAddress
           * @member stationType
           * @member mid
           */
          type record GN_Address {
            TypeOfAddress   typeOfAddress,
            StationType     stationType,
            UInt10          reserved,
garciay's avatar
garciay committed
            Oct6            mid
          } with { 
            variant "FIELDORDER(msb)" 
          }
                    
          group geoNetworkingAddressSubtypes {
                        
            /**
             * @desc Identifies the ITS station (5Bits).
             */
            type enumerated StationType {
              e_unknown(0),
              e_pedestrian(1),
              e_cyclist(2),
              e_moped(3),
              e_motorcycle(4),
              e_passengerCar(5),
              e_bus(6),
              e_lightTruck(7),
              e_heavyTruck(8),
              e_trailer(9),
              e_specialVehicle(10),
              e_tram(11),
              e_roadSideUnit(15)
            } with {
              variant "FIELDLENGTH(5)" //variant "5 bit"
            }
                        
            /**
             * @desc Distinguish between manually configured
             * network address and the initial GeoNetwork address (1Bit).
             */
            type enumerated TypeOfAddress {
              e_manual(1),
              e_initial(0)
            } with {
              variant "FIELDLENGTH(1)" //variant "1 bit"
            }
                        
          } // end group geoNetworkingAddressSubtypes
                    
        } // end group geoNetworkingAddress
                
      } // end group geoNetworkingHeadersSubtypes
            
    } // end group geoNetworkingExtendedHeaders
        
  } // end group geoNetworkingHeader
    
  group geoNwPicsTypes {
        
    /**
     * @desc The GeoUnicast forwarding algorithm.
     */
        type enumerated NonAreaForwardingAlgorithm {
garciay's avatar
garciay committed
      e_unspecified(0),
      e_greedy(1),
      e_cbf(2)
      }
        
    /**
     * @desc The GeoBroadcast forwarding algorithm.
     */
        type enumerated AreaForwardingAlgorithm {
garciay's avatar
garciay committed
      e_unspecified(0),
      e_simple(1),
      e_cbf(2),
      e_advanced(3)
      }
        
    /**
     * @desc GN address configuration method.  
     */
    type enumerated GnAddressConfigurationMethod {
      e_auto(0),
      e_managed(1),
      e_anonymous(2)   
      }
        
  } // end geoNwPicsTypes
    
  group utPrimitives {
        
    /**
     * @desc Upper Tester message to initialize IUT 
     * @member hashedId8 In case of secured mode set, hashedId8 indicate which certificate the IUT shall use
     */
    type record UtGnInitialize {
      Oct8 hashedId8 
      } with {
      variant "FIELDORDER(msb)"
      }

    /**
     * @desc Upper Tester results message of the GeoNetworking IUT
     * @member utGnInitialize             -
     * @member utGnTriggerResult          -
     * @member utAutoInteropTriggerResult -
     * @member utGnChangePositionResult     -
     */
    type union UtGnResults {
      boolean utGnInitializeResult,
        boolean utGnTriggerResult,
        boolean utAutoInteropTriggerResult, // FIXME Remove UtAutoInteropTrigger from GN component, create an AutoInterop component
        boolean utGnChangePositionResult
      } with {
      variant ""
      } // End of type UtGnResults
	
        /**
         * @desc AutoInterop UpperTester trigger
         * @member utRadioOnOff Set to true to power on the radio (on-link mode), false to power off the radio (off-link).
         */
    type union UtAutoInteropTrigger {
      boolean utRadioOnOff
    } with {
      variant ""
      } // End of type UtAutoInteropTrigger
        
        /**
         * @desc Upper Tester message to change the position of IUT. Values a relatives 
         */
    type record UtGnChangePosition {
      Int32 latitude,
      Int32 longitude,
      Int32 elevation
      } with {
      variant "FIELDORDER(msb)"
      }
        
    /**
     * @desc    UT primitives for GeoNetworking
     * @member  geoUnicast      -
     * @member  geoBroadcast    -
     * @member  geoAnycast      -
     * @member  shb             -
     * @member  tsb             -
     * @member  changePosition  -
     * @member  checkPacket     -
     */
    type union UtGnTrigger {
      GenerateGeoUnicastMessage geoUnicast,
        GenerateGeoBroadcastMessage geoBroadcast,
        GenerateGeoAnycastMessage geoAnycast,
        GenerateSHBMessage shb,
        GenerateTSBMessage tsb
    } with {
      variant ""
    }
        
    /**
     * @desc    UT primitive for IUT to send a GeoUnicast packet
     * @member  gnAddress       Destination of the packet
     * @member  lifetime        Lifetime of the packet
     * @member  trafficClass    Traffic class of the packet
     * @member  payload         GnRawPayload of the packet
     */
    type record GenerateGeoUnicastMessage {
      GN_Address gnAddress,
      UInt16 lifetime,
      TrafficClass trafficClass,
      GnRawPayload payload 
    } with {
      variant "FIELDORDER(msb)"
    }
        
    /**
     * @desc    UT primitive for IUT to send a GeoBroadcast packet
     * @member  shape           Shape of the area
     * @member  lifetime        Lifetime of the packet
     * @member  trafficClass    Traffic class of the packet