LibItsMapemSpatem_Templates.ttcn 45.1 KB
Newer Older
1
/**
garciay's avatar
garciay committed
2
 *    @author   ETSI / STF484 / STF517
Yann Garcia's avatar
Yann Garcia committed
3
4
 *    @version  $Url: https://oldforge.etsi.org/svn/LibIts/tags/20170222_STF527_Final/ttcn/MapemSpatem/LibItsMapemSpatem_Templates.ttcn $
 *              $Id: LibItsMapemSpatem_Templates.ttcn 1317 2017-01-26 07:05:19Z garciay $
5
 *    @desc     Module containing base template definitions for MAPEM SPATEM
garciay's avatar
garciay committed
6
7
8
9
 *    @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.
10
11
12
13
14
15
16
17
18
19
20
21
22
 *
 */
module LibItsMapemSpatem_Templates {

    // LibCommon
    import from LibCommon_BasicTypesAndValues all;
    import from LibCommon_DataStrings all;
    
    // LibIts
    import from ITS_Container language "ASN.1:1997" all;
    import from MAPEM_PDU_Descriptions language "ASN.1:1997" all;
    import from SPATEM_PDU_Descriptions language "ASN.1:1997" all;
    import from DSRC language "ASN.1:1997" all;
23
    import from DSRC_REGION_noCircular language "ASN.1:1997" all;
24
25
26
27
    
    // LibItsCommon
    import from LibItsCommon_Functions all;
    import from LibItsCommon_TypesAndValues all;
28
29
    import from LibItsCommon_ASN1_NamedNumbers all;
    import from LibItsCommon_ASN1_ISDSRC_NamedNumbers all;
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
    
    // LibItsMapemSpatem
    import from LibItsMapemSpatem_TestSystem all;
    import from LibItsMapemSpatem_TypesAndValues all;
    import from LibItsMapemSpatem_Pixits all;

    group primitivesTemplates {
        
        /**
         * @desc    Send template for MAPEM Message (MapemSpatemPort Primitive)
         * @param   p_mapemMsg    The MAPEM Message to be sent
         */
        template (value) MapemReq m_mapemReq(
                                             in template (value) MAPEM p_mapemMsg
        ) := {
            msgOut := p_mapemMsg
        }
        
        /**
         * @desc    Receive template for MAPEM Message (MapemSpatemPort Primitive)
         * @param   p_mapemMsg    The expected MAPEM Message
         */
        template (present) MapemInd mw_mapemInd(
                                                template (present) MAPEM p_mapemMsg
        ) := {
garciay's avatar
garciay committed
55
56
57
58
59
60
61
62
63
64
            msgIn               := p_mapemMsg,
            gnNextHeader        := *,
            gnHeaderType        := *,
            gnHeaderSubtype     := *,
            gnLifetime          := *,
            gnTrafficClass      := *,
            btpDestinationPort  := *,
            btpInfo             := *,
            ssp                 := *,
            its_aid             := * 
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
        }
        
        /**
         * @desc    Receive template for MAPEM Message (MapemSpatemPort Primitive)
         * @param   p_mapemMsg          The expected MAPEM Message
         * @param   p_gnNextHeader      GN next header value
         * @param   p_gnHeaderType      GN header type value
         * @param   p_gnHeaderSubtype   GN header subtype value
         * @param   p_gnLifetime        GN packet lifetime value (ms)
         * @param   p_gnTrafficClass    GN traffic class value
         */
        template (present) MapemInd mw_mapemIndWithGnParameters(
                                                                template (present) MAPEM p_mapemMsg,
                                                                in template UInt8 p_gnNextHeader := *,
                                                                in template UInt8 p_gnHeaderType := *,
                                                                in template UInt8 p_gnHeaderSubtype := *,
                                                                in template UInt32 p_gnLifetime := *,
                                                                in template UInt8 p_gnTrafficClass := *
        ) modifies mw_mapemInd := { 
garciay's avatar
garciay committed
84
85
            gnNextHeader    := p_gnNextHeader,
            gnHeaderType    := p_gnHeaderType,
86
            gnHeaderSubtype := p_gnHeaderSubtype,
garciay's avatar
garciay committed
87
88
            gnLifetime      := p_gnLifetime,
            gnTrafficClass  := p_gnTrafficClass
89
90
91
92
93
94
95
96
        }
        
        /**
         * @desc    Receive template for MAPEM Message (MapemSpatemPort Primitive)
         * @param   p_mapemMsg              Expected MAPEM Message
         * @param   p_btpDestinationPort    BTP destination port value
         * @param   p_btpInfo               BTP destination port info value (if BTP-B) or BTP source port value (if BTP-A)
         */
Yann Garcia's avatar
Yann Garcia committed
97
98
99
100
        template (present) MapemInd mw_mapemIndWithBtpParameters(
                                                                 template (present) MAPEM p_mapemMsg,
                                                                 template UInt16 p_btpDestinationPort := *,
                                                                 template UInt16 p_btpInfo := *
101
        ) modifies mw_mapemInd := { 
garciay's avatar
garciay committed
102
103
            btpDestinationPort  := p_btpDestinationPort,
            btpInfo             := p_btpInfo     
104
105
106
107
108
109
110
111
112
113
        };
        
        /**
         * @desc    Receive template for MAPEM Message (MapemSpatemPort Primitive)
         * @param   p_mapemMsg  The expected MAPEM Message
         * @param   p_ssp       SSP value
         * @param   p_its_aid   ITS-AID value
         */
        template (present) MapemInd mw_mapemIndWithSecurityParameters(
                                                                      template (present) MAPEM p_mapemMsg,
114
                                                                      template Bit256 p_ssp := *,
115
                                                                      template UInt32 p_its_aid := *
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
        ) modifies mw_mapemInd := { 
            ssp     := p_ssp,
            its_aid := p_its_aid
        }
        
        /**
         * @desc    Send template for SPATEM Message (MapemSpatemPort Primitive)
         * @param   p_spatemMsg    The SPATEM Message to be sent
         */
        template (value) SpatemReq m_spatemReq(
                                               in template (value) SPATEM p_spatemMsg
        ) := {
            msgOut := p_spatemMsg
        }
        
        /**
         * @desc    Receive template for SPATEM Message (MapemSpatemPort Primitive)
         * @param   p_spatemMsg    The expected SPATEM Message
         */
        template (present) SpatemInd mw_spatemInd(
                                                  template (present) SPATEM p_spatemMsg
        ) := {
garciay's avatar
garciay committed
138
139
140
141
142
143
144
145
146
147
            msgIn               := p_spatemMsg,
            gnNextHeader        := *,
            gnHeaderType        := *,
            gnHeaderSubtype     := *,
            gnLifetime          := *,
            gnTrafficClass      := *,
            btpDestinationPort  := *,
            btpInfo             := *,
            ssp                 := *,
            its_aid             := * 
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
        };

        /**
         * @desc    Receive template for SPATEM Message (MapemSpatemPort Primitive)
         * @param   p_spatemMsg         The expected SPATEM Message
         * @param   p_gnNextHeader      GN next header value
         * @param   p_gnHeaderType      GN header type value
         * @param   p_gnHeaderSubtype   GN header subtype value
         * @param   p_gnLifetime        GN packet lifetime value (ms)
         * @param   p_gnTrafficClass    GN traffic class value
         */
        template (present) SpatemInd mw_spatemIndWithGnParameters(
                                                                  template (present) SPATEM p_spatemMsg,
                                                                  in template UInt8 p_gnNextHeader := *,
                                                                  in template UInt8 p_gnHeaderType := *,
                                                                  in template UInt8 p_gnHeaderSubtype := *,
                                                                  in template UInt32 p_gnLifetime := *,
                                                                  in template UInt8 p_gnTrafficClass := *
        ) modifies mw_spatemInd := { 
garciay's avatar
garciay committed
167
168
            gnNextHeader    := p_gnNextHeader,
            gnHeaderType    := p_gnHeaderType,
169
            gnHeaderSubtype := p_gnHeaderSubtype,
garciay's avatar
garciay committed
170
171
            gnLifetime      := p_gnLifetime,
            gnTrafficClass  := p_gnTrafficClass
172
173
174
175
176
177
178
179
        }
        
        /**
         * @desc    Receive template for SPATEM Message (MapemSpatemPort Primitive)
         * @param   p_spatemMsg             Expected MAPEM Message
         * @param   p_btpDestinationPort    BTP destination port value
         * @param   p_btpInfo               BTP destination port info value (if BTP-B) or BTP source port value (if BTP-A)
         */
Yann Garcia's avatar
Yann Garcia committed
180
181
182
183
        template (present) SpatemInd mw_spatemIndWithBtpParameters(
                                                                   template (present) SPATEM p_spatemMsg,
                                                                   template UInt16 p_btpDestinationPort := *,
                                                                   template UInt16 p_btpInfo := *
184
        ) modifies mw_spatemInd := { 
garciay's avatar
garciay committed
185
186
            btpDestinationPort  := p_btpDestinationPort,
            btpInfo             := p_btpInfo
187
188
189
190
191
192
193
194
195
        };

        /**
         * @desc    Receive template for SPATEM Message (MapemSpatemPort Primitive)
         * @param   p_spatemMsg  The expected SPATEM Message
         * @param   p_ssp        SSP value
         * @param   p_its_aid    ITS-AID value
         */
        template (present) SpatemInd mw_spatemIndWithSecurityParameters(
garciay's avatar
garciay committed
196
                                                                        template (present) SPATEM p_spatemMsg,
197
                                                                        template Bit256 p_ssp := *,
198
                                                                        template UInt32 p_its_aid := *
199
200
201
202
203
204
205
206
207
208
209
210
211
        ) modifies mw_spatemInd := { 
            ssp     := p_ssp,
            its_aid := p_its_aid
        }
        
    }

    group utPrimitives {
            
        /**
         * @desc    Send template for Upper Tester event initialization
         * @member hashedId8 In case of secured mode set, hashedId8 indicate which certificate the IUT shall use
        */
212
        template (value) UtMapemSpatemInitialize m_mapemSpatemInitialize := {
213
214
215
216
            hashedId8 := '0000000000000000'O
        }

        /**
Yann Garcia's avatar
Yann Garcia committed
217
218
219
220
221
222
223
224
225
226
227
228
         * @desc    Send template for Upper Tester Trigger event
         */
        template (omit) UtMapemSpatemTrigger m_utTriggerEvent(
                                                              in Event p_event,
                                                              in template (omit) IntersectionID p_intersectionID := omit,
                                                              in template (omit) RegulatorySpeedLimit p_regulatorySpeedLimit := omit,
                                                              in template (omit) Latitude p_latitude := omit
                                                              ) := {
            event                := p_event,
            intersectionID       := p_intersectionID,
            regulatorySpeedLimit := p_regulatorySpeedLimit,
            latitude             := p_latitude
229
230
231
232
233
234
235
236
237
238
239
240
        }
    }

    group mapSpatPduTemplates {
        
        /**
         * @desc    Send template for MAPEM PDU
         * @param   p_map  The MAPEM Message
         */
        template (value) MAPEM m_mapemPdu(
                                          in template (value) MapData p_map
        ) := {
241
            header  := m_itsPduHeader( - , - ,LibItsCommon_ASN1_NamedNumbers.ItsPduHeader_messageID_mapem_ ),
garciay's avatar
garciay committed
242
            map_    := p_map
243
244
245
246
247
248
249
250
251
        }
        
        /**
         * @desc    Receive template for MAPEM PDU
         * @param   p_map  The MAPEM Message
         */
        template (present) MAPEM mw_mapemPdu(
                                             template (present) MapData p_map := ?
        ) := {
garciay's avatar
garciay committed
252
253
            header  := mw_itsPduHeaderMapem,
            map_    := p_map
254
255
256
257
258
259
260
261
262
        }
        
        /**
         * @desc    Send template for SPATEM PDU
         * @param   p_spat  The SPATEM Message
         */
        template (value) SPATEM m_spatemPdu(
                                            in template (value) SPAT p_spat
        ) := {
263
            header  := m_itsPduHeader( - , - , LibItsCommon_ASN1_NamedNumbers.ItsPduHeader_messageID_spatem_ ),
garciay's avatar
garciay committed
264
            spat    := p_spat
265
266
267
268
269
270
271
272
273
        }
        
        /**
         * @desc    Receive template for SPATEM PDU
         * @param   p_spat  The SPATEM Message
         */
        template (present) SPATEM mw_spatemPdu(
                                               template (present) SPAT p_spat := ?
        ) := {
garciay's avatar
garciay committed
274
275
            header  := mw_itsPduHeaderSpatem,
            spat    := p_spat
276
277
278
279
280
281
282
283
284
285
        }
        
    } // End of group mapSpatPduTemplates
    
    group headerTemplates {
        
        /**
         * @desc    Default send template for ITS PDU header
         * @param   p_stationID         The source station ID (Default: test system station id)
         * @param   p_protocolVersion   The protocol version (Default: current MAPEM SPATEM protocol version)
garciay's avatar
garciay committed
286
         * @param   p_messageID         The message Id (Default: MAPEM SPATEM id)
287
288
289
         */
        template (value) ItsPduHeader m_itsPduHeader(
                                                     in template (value) StationID p_stationID := f_getTsStationId(),
290
                                                     in template (value) ItsPduHeader.protocolVersion p_protocolVersion := LibItsCommon_ASN1_NamedNumbers.ItsPduHeader_protocolVersion_currentVersion_,
291
292
293
                                                     in template (value) ItsPduHeader.messageID p_messageID
        ) := {
            protocolVersion := p_protocolVersion,
garciay's avatar
garciay committed
294
295
            messageID       := p_messageID,
            stationID       := p_stationID
296
297
298
299
300
301
        }
        
        /**
         * @desc    Default receive template for ITS PDU header
         * @param   p_stationID         The expected station id (Default: any)
         * @param   p_protocolVersion   The expected protocol version (Default: current MAPEM SPATEM protocol version)
garciay's avatar
garciay committed
302
         * @param   p_messageID         The expected message id (Default: MAPEM SPATEM message id)
303
304
305
         */
        template ItsPduHeader mw_itsPduHeader(
                                              template (present) StationID p_stationID := ?,
306
                                              template (present) ItsPduHeader.protocolVersion p_protocolVersion := LibItsCommon_ASN1_NamedNumbers.ItsPduHeader_protocolVersion_currentVersion_,
307
308
309
                                              template (present) ItsPduHeader.messageID p_messageID := ?
        ) := {
            protocolVersion := p_protocolVersion,
garciay's avatar
garciay committed
310
311
            messageID       := p_messageID,
            stationID       := p_stationID
312
313
314
315
316
317
        }
        
        /**
         * @desc    Default receive template for ITS PDU header
         * @param   p_stationID         The expected station id (Default: any)
         * @param   p_protocolVersion   The expected protocol version (Default: current MAPEM SPATEM protocol version)
garciay's avatar
garciay committed
318
         * @param   p_messageID         The expected message id (Default: MAPEM id)
319
         */
YannGarcia's avatar
YannGarcia committed
320
        template (present) ItsPduHeader mw_itsPduHeaderMapem(
Yann Garcia's avatar
Yann Garcia committed
321
322
323
                                                             template (present) StationID p_stationID := ?,
                                                             template (present) ItsPduHeader.protocolVersion p_protocolVersion := LibItsCommon_ASN1_NamedNumbers.ItsPduHeader_protocolVersion_currentVersion_,
                                                             template (present) ItsPduHeader.messageID p_messageID := LibItsCommon_ASN1_NamedNumbers.ItsPduHeader_messageID_mapem_
324
325
        ) := {
            protocolVersion := p_protocolVersion,
garciay's avatar
garciay committed
326
327
            messageID       := p_messageID,
            stationID       := p_stationID
328
329
330
331
332
333
        }
        
        /**
         * @desc    Default receive template for ITS PDU header
         * @param   p_stationID         The expected station id (Default: any)
         * @param   p_protocolVersion   The expected protocol version (Default: current MAPEM SPATEM protocol version)
garciay's avatar
garciay committed
334
         * @param   p_messageID         The expected message id (Default: SPATEM id)
335
         */
YannGarcia's avatar
YannGarcia committed
336
        template (present) ItsPduHeader mw_itsPduHeaderSpatem(
Yann Garcia's avatar
Yann Garcia committed
337
338
339
                                                              template (present) StationID p_stationID := ?,
                                                              template (present) ItsPduHeader.protocolVersion p_protocolVersion := LibItsCommon_ASN1_NamedNumbers.ItsPduHeader_protocolVersion_currentVersion_,
                                                              template (present) ItsPduHeader.messageID p_messageID := LibItsCommon_ASN1_NamedNumbers.ItsPduHeader_messageID_spatem_
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
        ) := {
            protocolVersion := p_protocolVersion,
            messageID := p_messageID,
            stationID := p_stationID
        }
        
        /**
         * @desc    Default receive template for the station id
         */
        template (present) StationID mw_anyStationId := ?;
        
    } // End of group headerTemplates

    group mapemSpatemTemplates {
        
garciay's avatar
garciay committed
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
        template (omit) IntersectionReferenceID m_intersectionReferenceID(
                                                                          in template (value) IntersectionID p_intersectionID := 0,
                                                                          in template (omit) RoadRegulatorID p_roadRegulatorID := omit
        ) := {
            region  := p_roadRegulatorID,   // a globally unique regional assignment value typical assigned to a regional DOT authority the value zero shall be used for testing needs
            id      := p_intersectionID     // a unique mapping to the intersection in question within the above region of use
        }
        
        template (omit) Connection m_connction(
                                               in template (value) ConnectingLane p_connectingLane, 
                                               in template (omit) IntersectionReferenceID p_remoteIntersection := omit,
                                               in template (omit) SignalGroupID p_signalGroup := omit,
                                               in template (omit) RestrictionClassID p_userClass := omit,
                                               in template (omit) LaneConnectionID p_connectionID := omit
        ) := {
            connectingLane      := p_connectingLane,        // The index of the connecting lane and also the maneuver from the current lane to it
            remoteIntersection  := p_remoteIntersection,    // This entry is only used when the indicated connecting lane belongs to another intersection layout.
            signalGroup         := p_signalGroup,           // The matching signal group send by the SPAT message for this lane/maneuver.
            userClass           := p_userClass,             // The Restriction Class of users this applies to
            connectionID        := p_connectionID           // An optional connection index used to relate this lane connection to any dynamic clearance data in the SPAT
        }
        
377
378
        group mapemTemplates {
            
garciay's avatar
garciay committed
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
            group mapemTemplatesSend {
                
                /**
                 * @desc    Send template for MAPEM Message
                 */
                template (value) MapData m_defaultMapem := {
                    timeStamp         := omit,
                    msgIssueRevision  := PX_MSG_ISSUE_REVISION,
                    layerType         := omit,
                    layerID           := omit,
                    intersections     := omit,
                    roadSegments      := omit,
                    dataParameters    := omit,
                    restrictionList   := omit,
                    regional          := omit
                }
                
                /**
                 * @desc    Receive template for MAPEM Message
                 */
Yann Garcia's avatar
Yann Garcia committed
399
                template (omit) MapData m_mapem(
Yann Garcia's avatar
Yann Garcia committed
400
401
402
                                                 in template (value) MsgCount p_msgIssueRevision,
                                                 in template (omit) IntersectionGeometryList p_intersectionGeometryList := omit,
                                                 in template (omit) RoadSegmentList p_roadSegments := omit
garciay's avatar
garciay committed
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
                ) modifies m_defaultMapem := {
                    msgIssueRevision  := p_msgIssueRevision,
                    intersections     := p_intersectionGeometryList,
                    roadSegments      := p_roadSegments
                }
                
                template (omit) IntersectionGeometry m_intersectionGeometry(
                                                                            in template (value) IntersectionReferenceID p_intersectionReferenceID,
                                                                            in template (value) MsgCount p_revision,
                                                                            in template (value) Position3D p_position3D,
                                                                            in template (value) LaneList p_laneList,
                                                                            in template (omit) LaneWidth p_laneWidth := 2000
                ) := {
                    name                := omit,                        //For debug use only
                    id                  := p_intersectionReferenceID,   // A globally unique value set, consisting of a regionID and intersection ID assignment
                    revision            := p_revision,                  // Required default values about lane descriptions follow
                    refPoint            := p_position3D,                // The reference from which subsequent data points are offset until a new point is used. 
                    laneWidth           := p_laneWidth,                 // Reference width used by all subsequent lanes unless a new width is given speedLimits SpeedLimitList OPTIONAL, 
421
                    speedLimits         := omit,
garciay's avatar
garciay committed
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
                    laneSet             := p_laneList,                  // Data about one or more lanes (all lane data is found here)
                    preemptPriorityData := omit,                        // data about one or more regional preempt or priority zones 
                    regional            := omit
                }
                
                template (value) Position3D m_position3D(
                                                         in template (value) Latitude p_latitude,
                                                         in template (value) Longitude p_longitude
                ) := {
                    lat        := p_latitude,   // in 1/10th micro degrees
                    long       := p_longitude,  // in 1/10th micro degrees
                    elevation  := omit,         // in 10 cm units
                    regional   := omit
                }
                
                template (omit) GenericLane m_laneList(
                                                       in template (value) LaneID p_laneID, 
                                                       in template (value) LaneAttributes p_laneAttributes, 
                                                       in template (value) NodeListXY p_nodeListXY,
                                                       in template (omit) ConnectsToList p_connectsToList := omit, 
                                                       in template (omit) ApproachID p_ingressApproach := omit,
                                                       in template (omit) ApproachID p_egressApproach := omit,
                                                       in template (omit) AllowedManeuvers p_allowedManeuvers := omit
                ) := {
                    laneID          :=  p_laneID,           // The unique ID number assigned to this lane object
                    name            := omit,                // often for debug use only but at times used to name ped crossings
                    ingressApproach := p_ingressApproach,   // inbound Approach IDs to which this lane belongs
                    egressApproach  := p_egressApproach,    // outbound Approach IDs to which this lane belongs
                    laneAttributes  := p_laneAttributes,    // All Attribute information about the basic selected lane type
                    maneuvers       := p_allowedManeuvers,  // the permitted maneuvers for this lane
                    nodeList        := p_nodeListXY,        // Lane spatial path information as well as various Attribute information along the node path  
                                                            // Attributes found here are more general and may come and go over the length of the lane.
                    connectsTo      := p_connectsToList,    // a list of other lanes and their signal group IDs each connecting lane and its signal group ID is given, therefore this element provides the information formerly in "signalGroups" in prior editions.
                    overlays        := omit,
                    regional        := omit
                }
                
                template (omit) RoadSegment m_roadSegment(
                                                          in template (value) RoadSegmentReferenceID p_id,
                                                          in template (value) MsgCount p_revision,
                                                          in template (value) Position3D p_position3D,
                                                          in template (value) RoadLaneSetList p_roadLaneSet,
                                                          in template (omit) SpeedLimitList p_speedLimits := omit,
                                                          in template (omit) LaneWidth p_laneWidth := 2000
                ) := {
                    name        := omit,
                    id          := p_id,            // a globally unique value for the segment
                    revision    := p_revision,      // Required default values about the descriptions to follow
                    refPoint    := p_position3D,    // the reference from which subsequent data points are offset until a new point is used.
                    laneWidth   := p_laneWidth,     // Reference width used by all subsequent lanes unless a new width is given  
                    speedLimits := p_speedLimits,   // Reference regulatory speed limits used by all subsequent lanes unless a new speed is given   
                    roadLaneSet := p_roadLaneSet,
                    regional    := omit
                }
                
                template (value) RegulatorySpeedLimit m_speedLimits(
                                                                    in template (value) SpeedLimitType p_speedLimitType, 
                                                                    in template (value) Velocity p_velocity
                ) := {
                    type_   := p_speedLimitType,    // The type of regulatory speed which follows
                    speed   := p_velocity           // The speed in units of 0.02 m/s
                }
                
            } // End of group mapemTemplatesSend 
486
            
garciay's avatar
garciay committed
487
488
489
490
491
492
493
494
495
496
497
            group mapemTemplatesRecv {
                
                /**
                 * @desc    Receive template for MAPEM Message
                 */
                template (present) MapData mw_defaultMapem := {
                    timeStamp         := *,
                    msgIssueRevision  := ?,
                    layerType         := *,
                    layerID           := *,
                    intersections     := *,
Yann Garcia's avatar
Yann Garcia committed
498
                    roadSegments      := ?,
garciay's avatar
garciay committed
499
500
501
502
503
504
505
506
                    dataParameters    := *,
                    restrictionList   := *,
                    regional          := *
                }
                
                /**
                 * @desc    Receive template for MAPEM Message with no LayerType
                 */
Yann Garcia's avatar
Yann Garcia committed
507
508
509
510
                template (present) MapData mw_mapem(
                                                    template (present) IntersectionGeometryList p_intersections := ?,
                                                    template (present) RoadSegmentList p_roadSegments := ?
                ) modifies mw_defaultMapem := {
garciay's avatar
garciay committed
511
                    layerType         := omit,
Yann Garcia's avatar
Yann Garcia committed
512
513
514
515
516
517
518
519
520
521
522
                    layerID           := omit,
                    intersections     := p_intersections,
                    roadSegments      := p_roadSegments
                }
                
                template (present) IntersectionReferenceID mw_intersectionReferenceID(
                                                                                      template (present) IntersectionID p_intersectionID := ?,
                                                                                      template RoadRegulatorID p_roadRegulatorID := *
                ) := {
                    region  := p_roadRegulatorID,   // a globally unique regional assignment value typical assigned to a regional DOT authority the value zero shall be used for testing needs
                    id      := p_intersectionID     // a unique mapping to the intersection in question within the above region of use
garciay's avatar
garciay committed
523
524
525
526
527
528
                }
                
                /**
                 * @desc    Receive template for MAPEM Message with no LayerType
                 */
                template (present) MapData mw_mapemLayerType(
Yann Garcia's avatar
Yann Garcia committed
529
530
531
532
                                                             template (present) IntersectionGeometryList p_intersections := ?,
                                                             template (present) RoadSegmentList p_roadSegments := ?,
                                                             template (present) LayerID p_layerID := ?
                ) modifies mw_mapem := {
garciay's avatar
garciay committed
533
534
535
536
537
538
539
540
541
542
543
544
545
546
                    layerType         := ?,
                    layerID           := p_layerID
                }
                
                template (present) IntersectionGeometry mw_intersectionGeometry(
                                                                                template (present) IntersectionReferenceID p_id := ?,
                                                                                template (present) MsgCount p_revision := ?,
                                                                                template (present) Position3D p_position3D := ?,
                                                                                template (present) LaneList p_laneList := ?
                ) := {
                    name                := *,                           //For debug use only
                    id                  := p_id,                        // A globally unique value set, consisting of a regionID and intersection ID assignment
                    revision            := p_revision,                  // Required default values about lane descriptions follow
                    refPoint            := p_position3D,                // The reference from which subsequent data points are offset until a new point is used. 
547
548
                    laneWidth           := *,                           // Reference width used by all subsequent lanes unless a new width is given
                    speedLimits         := *,
garciay's avatar
garciay committed
549
550
551
552
553
                    laneSet             := p_laneList,                  // Data about one or more lanes (all lane data is found here)
                    preemptPriorityData := *,                           // data about one or more regional preempt or priority zones 
                    regional            := *
                }
                
Yann Garcia's avatar
Yann Garcia committed
554
555
556
557
558
559
560
561
562
563
564
                template (present) Position3D mw_position3D(
                                                            template (present) Latitude p_latitude := ?,
                                                            template (present) Longitude p_longitude := ?,
                                                            template Position3D.regional p_regional := *
                ) := {
                    lat        := p_latitude,   // in 1/10th micro degrees
                    long       := p_longitude,  // in 1/10th micro degrees
                    elevation  := omit,         // in 10 cm units
                    regional   := p_regional
                }
                
garciay's avatar
garciay committed
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
                template (present) RoadSegment mw_roadSegment(
                                                              template (present) RoadSegmentReferenceID p_id := ?,
                                                              template (present) MsgCount p_revision := ?,
                                                              template (present) Position3D p_position3D := ?, 
                                                              template (present) RoadLaneSetList p_roadLaneSet := ?
                ) := {
                    name        := *,
                    id          := p_id,            // a globally unique value for the segment
                    revision    := p_revision,      // Required default values about the descriptions to follow
                    refPoint    := p_position3D,    // the reference from which subsequent data points are offset until a new point is used.
                    laneWidth   := *,               // Reference width used by all subsequent lanes unless a new width is given  
                    speedLimits := *,               // Reference regulatory speed limits used by all subsequent lanes unless a new speed is given   
                    roadLaneSet := p_roadLaneSet,
                    regional    := *
                }
                
Yann Garcia's avatar
Yann Garcia committed
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
                template (present) GenericLane mw_roadLane(
                                                           template (present) LaneID p_laneID := ?,
                                                           template (present) LaneAttributes p_laneAttributes := ?,
                                                           template ApproachID p_ingressApproach := *,
                                                           template ApproachID p_egressApproach := *,
                                                           template ConnectsToList p_connectsTo := *
                ) := {
                    laneID          := p_laneID, 
                    name            := *,
                    ingressApproach := p_ingressApproach,
                    egressApproach  := p_egressApproach,
                    laneAttributes  := p_laneAttributes, 
                    maneuvers       := *,
                    nodeList        := ?,
                    connectsTo      := p_connectsTo, 
                    overlays        := *, 
                    regional        := *
                }
                
garciay's avatar
garciay committed
600
            } // End of group mapemTemplatesRecv 
601
            
Yann Garcia's avatar
Yann Garcia committed
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
            template (present) NodeXY mw_nodeXY(
                                                template (present) NodeOffsetPointXY p_delta := ?,
                                                template (present) NodeAttributeSetXY p_attributes := ?
                                                ) := {
                delta := p_delta,
                attributes := p_attributes
            }
            
            template (present) NodeAttributeSetXY mw_nodeAttributeSetXY_default := {
                localNode  := *,
                disabled   := *,
                enabled    := *,
                data       := *,
                dWidth     := ?,
                dElevation := *,
                regional   := *
            }
            
620
621
622
623
        } // End of group mapemTemplates 
        
        group spatemTemplates {
            
garciay's avatar
garciay committed
624
625
            group spatemTemplatesSend {
                
626
                /**
garciay's avatar
garciay committed
627
             * @desc    Send default template for SPAT Message
628
                 */
garciay's avatar
garciay committed
629
            template (value) SPAT m_defaultSpatem := {
630
631
632
633
634
635
                    timeStamp      := omit,
                    name           := omit, 
                    intersections  := m_intersections,
                    regional       := omit
                }
                
garciay's avatar
garciay committed
636
637
638
            /**
             * @desc    Send template for SPAT Message
             */
YannGarcia's avatar
YannGarcia committed
639
                template (omit) SPAT m_spatem(
garciay's avatar
garciay committed
640
641
642
643
644
645
646
647
648
                                          in template (value) IntersectionStateList p_intersections,
                                          in template (omit) DescriptiveName p_name := omit
            ) modifies m_defaultSpatem:= {
                timeStamp      := omit,
                name           := p_name, 
                intersections  := p_intersections,
                regional       := omit
            }
            
649
650
                template (value) IntersectionStateList m_intersections := { m_intersection };
                
Yann Garcia's avatar
Yann Garcia committed
651
                template (value) IntersectionState m_intersection := {
garciay's avatar
garciay committed
652
653
654
                    name                := omit,                                                // Human readable name for intersection to be used only in debug mode
                    id                  := m_intersectionReferenceID,                           // A globally unique value set, consisting of a  regionID and 
                                                                                                // intersection ID assignment provides a unique mapping to the intersection MAP in question which provides complete location and approach/move/lane data
655
                    revision            := PX_INTERSECTIONSTATE_REVISION,
YannGarcia's avatar
YannGarcia committed
656
                    status              := IntersectionStatusObject_manualControlIsEnabled_,
657
                                                                                                // General status of the controller(s)
garciay's avatar
garciay committed
658
659
660
661
662
                    moy                 := omit,                                                // Minute of current UTC year used only with messages to be archived 
                    timeStamp           := omit,                                                // The mSec point in the current UTC minute that this message was constructed
                    enabledLanes        := { 1, 2 },                                            // A list of lanes where the RevocableLane bit has been set which are now active andtherefore part of the current intersection
                    states              := m_movements,                                         // Each Movement is given in turn and contains its signal phase state, mapping to the lanes it applies to, and point in time it will end, and it may contain both active and future states
                    maneuverAssistList  := omit,                                                // Assist data
663
664
665
666
667
                    regional            := omit
                }
                
                template (value) MovementList m_movements := { m_movement };
                
YannGarcia's avatar
YannGarcia committed
668
                template (omit) MovementState m_movement := {
669
670
671
                    movementName           := omit,
                    signalGroup            := PX_SIGNAL_GROUP_ID,
                    state_time_speed       := m_movementEventList,
garciay's avatar
garciay committed
672
                    maneuverAssistList     := { m_connectionManeuverAssist(1) },
673
674
675
676
677
                    regional               := omit
                }
                
                template (value) MovementEventList m_movementEventList := { m_movementEvent };
                
garciay's avatar
garciay committed
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
                template (omit) MovementEvent m_movementEvent(
                                                              in template (value) MovementPhaseState p_eventState := stop_Then_Proceed,
                                                              in template (omit) TimeChangeDetails p_timing := omit,
                                                              in template (omit) MovementEvent.speeds p_speeds := omit
                ) := {
                    eventState      := stop_Then_Proceed,   // Consisting of: Phase state (the basic 11 states) and Directional, protected, or permissive state
                    timing          := p_timing,            // Timing Data in UTC time stamps for event includes start and min/max end times of phase confidence and estimated next occurrence
                    speeds          := p_speeds,            // Various speed advisories for use by general and specific types of vehicles supporting green-wave and other flow needs
                    regional        := omit 
                }
                
                template (omit) ConnectionManeuverAssist m_connectionManeuverAssist(
                                                                                    in template (value) LaneConnectionID p_connectionID,
                                                                                    in template (omit) ZoneLength p_queueLength := omit,
                                                                                    in template (omit) ZoneLength p_availableStorageLength := omit,
                                                                                    in template (omit) WaitOnStopline p_waitOnStop := omit,
                                                                                    in template (omit) PedestrianBicycleDetect p_pedBicycleDetect := omit
                ) := { 
                    connectionID            := p_connectionID,
                    queueLength             := p_queueLength,
                    availableStorageLength  := p_availableStorageLength,
                    waitOnStop              := p_waitOnStop,
                    pedBicycleDetect        := p_pedBicycleDetect,
701
702
703
                    regional                := omit
                }
                
garciay's avatar
garciay committed
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
                template (omit) TimeChangeDetails m_itmeChangeDetails(
                                                                      in template (value) TimeMark p_minEndTime,
                                                                      in template (omit) TimeMark p_startTime := omit,
                                                                      in template (omit) TimeMark p_maxEndTime := omit,
                                                                      in template (omit) TimeMark p_likelyTime := omit,
                                                                      in template (omit) TimeIntervalConfidence p_confidence := omit,
                                                                      in template (omit) TimeMark p_nextTime := omit
                ) := {
                    startTime  := p_startTime,  // When this phase 1st started
                    minEndTime := p_minEndTime, // Expected shortest end time
                    maxEndTime := p_maxEndTime, // Expected longest end time
                    likelyTime := p_likelyTime, // Best predicted value based on other data
                    confidence := p_confidence, // Applies to above time element only
                    nextTime   := p_nextTime    // A rough estimate of time when this phase may next occur again used to support various ECO driving power management needs.
                }
                
                template (omit) AdvisorySpeed m_advisorySpeed(
                                                              in template (value) AdvisorySpeedType p_type,
                                                              in template (omit) SpeedAdvice p_speed := omit,
Yann Garcia's avatar
Yann Garcia committed
723
                                                              in template (omit) SpeedConfidenceDSRC p_confidence := omit,
garciay's avatar
garciay committed
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
                                                              in template (omit) ZoneLength p_distance := omit,
                                                              in template (omit) RestrictionClassID p_class := omit
                ) := {
                    type_       := p_type,          // The type of advisory which this is.
                    speed       := p_speed, 
                    confidence  := p_confidence,    // A confidence value for the above speed
                    distance    := p_distance,      // The distance indicates the region for which the advised speed  is recommended, it is specified upstream from the stop bar   along the connected egressing lane
                    class       := p_class,         // The vehicle types to which it applies when absent, the AdvisorySpeed applies to all motor vehicle types
                    regional    := omit
                }
                
            } // End of group spatemTemplatesSend
            
            group spatemTemplatesRecv {
                
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
                /**
                 * @desc    Receive template for SPATEM Message
                 */
                template (present) SPAT mw_defaultSpatem := {
                    timeStamp      := *,
                    name           := *, 
                    intersections  := ?,
                    regional       := *
                }
                
                template (present) SPAT mw_spatemWellFormatted 
                modifies mw_defaultSpatem := {
                }
                
                template (present) SPAT mw_spatem_with_region_id(
                                                                 template (present) SPAT.regional p_regional := ?
                ) modifies mw_defaultSpatem := {
garciay's avatar
garciay committed
756
                    regional       := p_regional 
757
758
759
                }
                
            } // End of group spatemTemplates
garciay's avatar
garciay committed
760
761
            
        } // End of group spatemTemplatesRecv 
762
763
764
765
        
    } // End of group mapemSpatemTemplates

} // End of module LibItsMapemSpatem_Templates