Commit 29d65b03 authored by garciay's avatar garciay
Browse files

Add comments

Renaming
parent 3b317d2b
Loading
Loading
Loading
Loading
+39 −26
Original line number Diff line number Diff line
@@ -82,9 +82,9 @@ module LibItsFsap_Templates {
            
        } // End of group taPrimitives
        
        group cregServerMessagePDU {
        group cregServerMessage {
            
            group cregServerMessagePDUSend {
            group cregServerMessageSend {
                
                /**
                 * @desc    Send a GCregServer registration request for an ITS-S application
@@ -110,12 +110,15 @@ module LibItsFsap_Templates {
                    } // End of field 'mfReq'
                } // End of template m_mfRequest_GCregServer
                
            } // End of group cregServerMessagePDUSend
            } // End of group cregServerMessageSend
            
            group cregServerMessagePDURecv {
            group cregServerMessageRecv {
                
                /**
                 * @desc    Generic receive GCregServer template
                 * Used for:
                 * <li>modifying restrictif template</li>
                 * <li>default altstep</li>
                 * @see ISO 24102-3 Table C.1 — MF-REQUESTs 
                 * @see ISO 24102-5 Clause 8.2.1 Groupcast registration 
                 */
@@ -134,13 +137,13 @@ module LibItsFsap_Templates {
                    } // End of field 'serviceDataReg'
                } // End of template mw_gCregServer
                
            } // End of group cregServerMessagePDURecv
            } // End of group cregServerMessageRecv
            
        } // End of group cregServerMessagePDU
        } // End of group cregServerMessage
        
        group cregClientMessagePDU {
        group cregClientMessage {
            
            group cregClientMessagePDUSend {
            group cregClientMessageSend {
                
                /**
                 * @desc    Send template for a  GCregClient without a session, CTX is not requested
@@ -184,10 +187,10 @@ module LibItsFsap_Templates {
                    } // End of field 'mfReq'
                } // End of template m_mfRequest_GCregClientWithSessionAndCTX
                
            } // End of group cregClientMessagePDUSend
            } // End of group cregClientMessageSend
            
            // TODO To be removed
//            group cregClientMessagePDURecv {
//            group cregClientMessageRecv {
//                
//                /**
//                 * @desc    Send template for GCregClient
@@ -227,12 +230,12 @@ module LibItsFsap_Templates {
//                    contextData := ?
//                } // End of template mw_gCregClient
//                
//            } // End of group cregClientMessagePDURecv
//            } // End of group cregClientMessageRecv
            
        } // End of group cregClientMessagePDU
        } // End of group cregClientMessage
        
        // TODO To be removed
//        group cderegClientMessagePDU {
//        group cderegClientMessage {
//            
//            /**
//             * @desc ITS-S application shall deregister its supported service at the groupcasting manager using the services of the groupcasting registration handler
@@ -264,11 +267,11 @@ module LibItsFsap_Templates {
//                }
//            } // End of template mw_gCderegClient
//            
//        } // End of group cderegClientMessagePDU
//        } // End of group cderegClientMessage
        
        group samMessagePDU {
        group samMessage {
            
            group samMessagePDUSend {
            group samMessageSend {
                
                /**
                 * @desc    Send template for a SAM from a service user ITS station, notified by the groupcast communication manager to the groupcast manager
@@ -298,12 +301,15 @@ module LibItsFsap_Templates {
                    } // End of field 'mfReq'
                } // End of template m_mfRequest_SAMrxNot
                
            } // End of group samMessagePDUSend
            } // End of group samMessageSend
            
            group samMessagePDURecv {
            group samMessageRecv {
                
                /**
                 * @desc    Generic receive MF-COMMAND template
                 * Used for:
                 * <li>modifying restrictif template</li>
                 * <li>default altstep</li>
                 * @see ISO 24102-3 Clause 8.2.1 
                 */
                template (present) MF_Command mw_mfCommand_any := {
@@ -374,13 +380,13 @@ module LibItsFsap_Templates {
                    } // End of field 'servData'
                } // End of template mw_samDataServerciceWithAccessTechAndNonIP
                
            } // End of group samMessagePDURecv
            } // End of group samMessageRecv
            
        } // End of group samMessagePDU
        } // End of group samMessage
        
        group ctxMessagePDU {
        group ctxMessage {
            
            group ctxMessagePDUSend {
            group ctxMessageSend {
                
                /**
                 * @desc    Send "CTX" in reply to SAM
@@ -470,9 +476,9 @@ module LibItsFsap_Templates {
//                    }
//                } // End of template m_cTXrxNot
                
            } // End of group ctxMessagePDUSend
            } // End of group ctxMessageSend
            
            group ctxMessagePDURecv {
            group ctxMessageRecv {
                
                /**
                 * @desc    Receive template for GCctx
@@ -515,6 +521,10 @@ module LibItsFsap_Templates {
                
                /**
                 * @desc    Generic receive template for CTX.
                 * Used for:
                 * <li>modifying restrictif template</li>
                 * <li>default altstep</li>
                 * @see ISO 24102-5 Clause 8.2.6 Reception of CTX
                 */
                template (present) CTX mw_ctx_any := {
                    fmtID := PX_FMTID_CTX, 
@@ -554,6 +564,9 @@ module LibItsFsap_Templates {
                
                /**
                 * @desc    Generic receive template for CTXserviceData
                 * Used for:
                 * <li>modifying restrictif template</li>
                 * <li>default altstep</li>
                 */
                template (present) CTXserviceData mw_ctxDataServercice_any := {
                    fill := ?,
@@ -607,9 +620,9 @@ module LibItsFsap_Templates {
//                    }
//                } // End of template mw_gCctxTxCmd
                
            } // End of group ctxMessagePDURecv
            } // End of group ctxMessageRecv
            
        } // End of group ctxMessagePDU
        } // End of group ctxMessage
        
    } // End of group fsapPrimitives
    
+13 −7
Original line number Diff line number Diff line
@@ -24,7 +24,7 @@ module LibItsIicp_Functions {
    // LibIts
    import from CALMmanagement language "ASN.1:1997" {
        type 
            ITS_scuId
            ITS_scuId, Talive
    };
    import from CALMiitsscu language "ASN.1:1997" {
        type 
@@ -296,7 +296,6 @@ module LibItsIicp_Functions {
         * @desc Gets the Local/source ITS scuID 
         * @return  The Local/source ITS scuID 
         * @see PX_LOCAL_ITS_SCU_ID 
         * @verdict Unchanged 
         * @see ISO/WD 24102-4 - Table 2 — ITS-SCU-ID value assignment
         */
        function f_getIutLocalITSscuId() return ITS_scuId {
@@ -304,9 +303,8 @@ module LibItsIicp_Functions {
        }
        
        /**
         * @desc    TODO
         * @return  TODO
         * @verdict Unchanged
         * @desc    Get the type of ITS-SCU in the "Data" element
         * @return  The type of ITS-SCU in the "Data" element
         * @see     PX_SRC_ITS_SCU_TYPE
         */
        function f_getIutSourceITS_scuType() return ITS_SCUtype {
@@ -318,13 +316,21 @@ module LibItsIicp_Functions {
         * @desc    Gets the type ITS scuID
         * @return  The type ITS scuID
         * @see PX_LOCAL_ITS_TYPE 
         * @verdict Unchanged 
         * @see ISO/WD 24102-4 - Table 2 — ITS-SCU-ID value assignment
         */
        function f_getIutLocalITSType() return ITS_SCUtype {
            return PX_LOCAL_ITS_TYPE;
        }
        
        /**
         * @desc    Gets the Alive timer
         * @return  The Alive timer
         * @see PX_TALIVE 
         */
        function f_getIutTAlive() return Talive {
            return PX_TALIVE;
        }
        
    } // End of group iutFunctions
    
} // End of module LibItsIicp_Functions
 No newline at end of file
+1 −1
Original line number Diff line number Diff line
@@ -62,7 +62,7 @@ module LibItsIicp_Pixits {
    modulepar ITS_scuId PX_HOST_SCU_ID := 0;
    
    /**
     * @desc TODO
     * @desc Alive timer
     */
    modulepar Talive PX_TALIVE := 100; // TODO Check whta is the role of Talive
    
+150 −59
Original line number Diff line number Diff line
@@ -69,10 +69,19 @@ module LibItsIicp_Templates {
            
        } // End of group taPrimitives
        
        group mfCommandRequest { // FIXME Check these templates are useful
        /**
         * @desc MF-SAP service primitives templates
         * @see ISO 24102-3 Clause 8.2.2 MF-COMMAND.request
         */
        group mfCommandRequest { 
            
            group recv_ { 
            group mfCommandRequestRecv { 
                
                /**
                 * @desc    Receive template for PduRequest/MF-COMMAND.request
                 * @param   p_mfCommandReq MF-COMMAND.request description 
                 * @see ISO 24102-4 Clause 8.2.1 IIC-Request PDU
                 */
                template (present) PduRequest mw_pduRequest_mfCommandReq( 
                    in template (present) MF_Command_request p_mfCommandReq 
                ) := {
@@ -82,6 +91,11 @@ module LibItsIicp_Templates {
                    }
                } // End of template mw_pduRequest_mfCommandReq
                
                /**
                 * @desc    Receive template for MF-COMMAND.request in case of forwarding the IIC-Request PDU to the IICA
                 * @param   p_iICrequestTX IICrequestTX description 
                 * @see ISO 24102-4 Clause 8.2.1 IIC-Request PDU
                 */
                template MF_Command_request mdw_mfCommandRequest_iICrequestTX(
                    in template (present) IICrequestTX p_iICrequestTX
                ) modifies mw_mfCommandRequest_any := {
@@ -92,6 +106,11 @@ module LibItsIicp_Templates {
                    }
                } // End of template mw_mfCommandRequest_iICrequestTX
                
                /**
                 * @desc    Receive template for MF-COMMAND.request in case of forwarding the IIC-Response PDU to the IICA
                 * @param   p_iICresponseTX IICresponseTX description 
                 * @see ISO 24102-4 Clause 8.2.2 IIC-Response PDU
                 */
                template MF_Command_request mdw_mfCommandRequest_iICresponseTX(
                    in template (present) IICresponseTX p_iICresponseTX
                ) modifies mw_mfCommandRequest_any := {
@@ -102,6 +121,11 @@ module LibItsIicp_Templates {
                    }
                } // End of template mdw_mfCommandRequest_iICresponseTX
                
                /**
                 * @desc    Receive template for MF-REQUEST.request in case of forwarding an IIC-Request PDU received via NF-SAP to the IICM
                 * @param   p_iICrequestRX IICrequestTX description 
                 * @see ISO 24102-4 Clause 8.3.1 IIC-Request PDU
                 */
                template MF_Request_request mdw_mfRequestRequest_iICrequestRX(
                    in template (present) IICrequestTX p_iICrequestRX
                ) modifies mw_mfRequestRequest_any := {
@@ -112,31 +136,75 @@ module LibItsIicp_Templates {
                    }
                } // End of template mdw_mfRequestRequest_iICrequestRX
                
                template IICrequestRX mw_mfRequestRx( 
                    in template (present) ITS_scuId p_sourceITS_scuId, 
                    in template (present) ITS_scuId p_destinationITS_scuId, 
                    in template (present) PduCounter p_pduCounter, 
                    in template (present) PduRequest pduRequest 
//                /**
//                 * @desc    Receive template for IICrequestRX
//                 * @param   p_sourceITS_scuId       The source ITS-SCU-ID
//                 * @param   p_destinationITS_scuId  The destination ITS-SCU-ID
//                 * @param   p_pduCounter            The PDU-Counter value
//                 * @param   pduRequest              The PduRequest description
//                 * @see ISO 24102-4 Clause 8.3.1 IIC-Request PDU
//                 */
//                template IICrequestRX mw_mfRequestRx( 
//                    in template (present) ITS_scuId p_sourceITS_scuId, 
//                    in template (present) ITS_scuId p_destinationITS_scuId, 
//                    in template (present) PduCounter p_pduCounter, 
//                    in template (present) PduRequest pduRequest 
//                ) := { 
//                    sourceITS_scuId := p_sourceITS_scuId,
//                    destinationITS_scuId := p_destinationITS_scuId,
//                    pduCounter := p_pduCounter,
//                    pduRequest := pduRequest,
//                    seqRq := ?
//                } // End of template mw_mfRequestRx 
//                
            } // End of group mfCommandRequestRecv
            
        } // End of group mfCommandRequest
        
        /**
         * @desc MF-SAP service primitives templates
         * @see ISO 24102-3 Clause 8.3.2 MF-REQUEST.request
         */
        group mfRequestRequest {
             
            group mfRequestRequestRecv {
                
                /**
                 * @desc    Receive template for MF-REQUEST.request in case of forwarding the IIC-Request PDU to the IICA
                 * @param   p_commandRef    Command reference
                 * @param   p_iICrequestRX  IICrequestRX message description
                 * @see ISO 24102-4 Clause 8.3.1 IIC-Request PDU
                 */
                template (value) MF_Request_request m_mfRequestRequest_iICrequestRX( 
                    in template (value) CommandRef p_commandRef, 
                    in template (value) IICrequestRX p_iICrequestRX 
                ) := { 
                    sourceITS_scuId := p_sourceITS_scuId,
                    destinationITS_scuId := p_destinationITS_scuId,
                    pduCounter := p_pduCounter,
                    pduRequest := pduRequest,
                    seqRq := ?
                } // End of template mw_mfRequestRx 
                    commandRef := p_commandRef, 
                    request_param := { 
                        fill := PX_PDU_REQUEST_FILL_FIELD_VALUE, 
                        mfReq := { 
                            iICrequestRX := p_iICrequestRX
                        } // End of 'mfReq' field 
                    } // End of 'request_param' field 
                } // End of template m_mfRequestRequest_iICrequestRX 
                
            } // End of group recv_
            } // End of group mfRequestRequestRecv
            
        } // End of group mfCommandRequest
        } // End of group mfRequestRequest
        
        /**
         * @desc ITS-SCUalive templates
         * @see ISO/WD 24102-4 Clause 9.2 
         * @see ISO 24102-4 Clause 9.2 ITS-SCU-ID assignment 
         */
        group alive_ {
        group aliveMessages {
            
            group send_ {
            group aliveMessagesSend {
                
                /**
                 * @desc    Send template for IIC-Request PDU ITS-SCUalive message
                 * @param   p_alive ITS_SCUalive message description
                 * @see ISO 24102-4 Clause 9.2 ITS-SCU-ID assignment 
                 */
                template (value) PduRequest m_pduRequest_SCUAlive( 
                    in template (value) ITS_SCUalive p_alive 
                ) := {
@@ -146,6 +214,12 @@ module LibItsIicp_Templates {
                    }
                } // End of template m_pduRequest_SCUAlive
                
                /**
                 * @desc    Send template for IIC-Request PDU ITS-SCUalive message
                 * @param   p_message       The Alive message (new, delete...)
                 * @param   p_its_scuType   The type of ITS-SCU in the "Data" element
                 * @see ISO 24102-4 Table 4 — Error handling procedure for IIC-Response PDU
                 */
                template (value) ITS_SCUalive m_scuAlive( 
                    in template (value) AliveMessage p_message,
                    in template (value) ITS_SCUtype p_its_scuType 
@@ -154,10 +228,29 @@ module LibItsIicp_Templates {
                    its_scuType := p_its_scuType
                } // End of template m_scuAlive_any
                
            } // End of group send_
            } // End of group aliveMessagesSend
            
            group recv_ {
            group aliveMessagesRecv {
                
                /**
                 * @desc    Receive template for ITS-SCUalive message
                 * @param   p_message       The Alive message (new, delete...)
                 * @param   p_its_scuType   The type of ITS-SCU in the "Data" element
                 * @see ISO 24102-4 Table 4 — Error handling procedure for IIC-Response PDU
                 */
                template ITS_SCUalive mw_scuAlive( 
                    in template (present) AliveMessage p_message,
                    in template (present) ITS_SCUtype p_its_scuType 
                ) := { 
                    message_ := p_message, 
                    its_scuType := p_its_scuType 
                } // End of template mw_scuAlive 
                
                /**
                 * @desc    Receive template for MF-REQUEST.request/IICrequestRX message
                 * @param   p_iICrequestRX IICrequestRX message description
                 * @see ISO 24102-4 Clause 8.3.1 IIC-Request PDU 
                 */
                template MF_Request mw_mfRequest_SCUAlive( 
                    in template (present) IICrequestRX p_iICrequestRX 
                ) := {
@@ -167,6 +260,13 @@ module LibItsIicp_Templates {
                    }
                } // End of template mw_mfRequest_SCUAlive
                
                /**
                 * @desc    Receive template for IICrequestTX/SCU-Alive message
                 * @param   p_sourceITS_scuId       The source ITS-SCU-ID
                 * @param   p_destinationITS_scuId  The destination ITS-SCU-ID
                 * @param   p_alive                 The Alive message (new, delete...)
                 * @see ISO 24102-4 Clause 8.2.1 IIC-Request PDU 
                 */
                template IICrequestTX mdw_iicRequestTx_SCUAlive( 
                    in template (present) ITS_scuId p_sourceITS_scuId, 
                    in template (present) ITS_scuId p_destinationITS_scuId, 
@@ -181,6 +281,14 @@ module LibItsIicp_Templates {
                    } // End of 'pduRequest' field 
                } // End of template mdw_iicRequestTx_SCUAlive 
                
                /**
                 * @desc    Receive template for IICrequestRX/SCU-Alive message
                 * @param   p_sourceITS_scuId       The source ITS-SCU-ID
                 * @param   p_destinationITS_scuId  The destination ITS-SCU-ID
                 * @param   p_alive                 The Alive message (alive, new, delete)
                 * @see ISO 24102-4 Clause 8.3.1 IIC-Request PDU 
                 * @see ISO 24102-4 Table B.2 — ITS-SCU-id request PDU
                 */
                template IICrequestRX mdw_iicRequestRx_SCUAlive( 
                    in template (present) ITS_scuId p_sourceITS_scuId, 
                    in template (present) ITS_scuId p_destinationITS_scuId, 
@@ -195,6 +303,15 @@ module LibItsIicp_Templates {
                    } // End of 'pduRequest' field 
                } // End of template mdw_iicRequestRx_SCUAlive 
                
                /**
                 * @desc    Receive template for IICresponseTX/SCU-Alive message
                 * @param   p_sourceITS_scuId       The source ITS-SCU-ID
                 * @param   p_destinationITS_scuId  The destination ITS-SCU-ID
                 * @param   p_alive                 The Alive message (new, delete...)
                 * @param   p_errorStatus           Error status
                 * @see ISO 24102-4 Clause 8.2.1 IIC-Request PDU 
                 * @see ISO 24102-4 Table 4 — Error handling procedure for IIC-Response PDU 
                 */
                template IICresponseTX mdw_iicResponseTx_SCUAlive( 
                    in template (present) ITS_scuId p_sourceITS_scuId, 
                    in template (present) ITS_scuId p_destinationITS_scuId, 
@@ -211,44 +328,18 @@ module LibItsIicp_Templates {
                    errorStatus := p_errorStatus 
                } // End of template mdw_iicResponseTx_SCUAlive
                
    //            template PduRequest mw_pduRequest_SCUAlive( 
    //                in template (present) ITS_SCUalive p_alive 
    //            ) := {
    //                fill := PX_PDU_REQUEST_FILL_FIELD_VALUE,
    //                requests := {
    //                    alive_ := p_alive
    //                }
    //            } // End of template mw_pduRequest_SCUAlive
    //            
                
                template ITS_SCUalive mw_scuAlive( 
                    in template (present) AliveMessage p_message,
                    in template (present) ITS_SCUtype p_its_scuType 
                ) := { 
                    message_ := p_message, 
                    its_scuType := p_its_scuType 
                } // End of template mw_scuAlive 
                
            } // End of group recv_
            } // End of group aliveMessagesRecv
            
        } // End of group alive_
        } // End of group aliveMessages
        
        /**
         * @desc ITS-SCUalive templates
         * @see ISO 24102-4 Clause 8.2.1 IIC-Request PDU
         * @see ISO 24102-4 Clause B.2.3 VCI-info 
         */
        group vciInfoReq { 
            
            group send_ { 
                
                template (value) MF_Request_request m_mfRequestRequest_iICrequestRX( 
                    in template (value) CommandRef p_commandRef, 
                    in template (value) IICrequestRX p_iICrequestRX 
                ) := { 
                    commandRef := p_commandRef, 
                    request_param := { 
                        fill := PX_PDU_REQUEST_FILL_FIELD_VALUE, 
                        mfReq := { 
                            iICrequestRX := p_iICrequestRX
                        } // End of 'mfReq' field 
                    } // End of 'request_param' field 
                } // End of template m_mfRequestRequest_iICrequestRX 
            group vciInfoReqSend { 
                
                template (value) IICrequestRX m_mfRequestRx( 
                    in template (value) ITS_scuId p_sourceITS_scuId, 
@@ -282,9 +373,9 @@ module LibItsIicp_Templates {
                    ciClass := p_ciClass 
                } // End of template m_vciInfoReq
                
            } // End of group send_
            } // End of group vciInfoReqSend
            
            group recv_ {
            group vciInfoReqSendRecv {
                
                template IICrequestRX mdw_iicRequestTx_VCIInfoReq(
                    in template (present) ITS_scuId p_sourceITS_scuId, 
@@ -316,7 +407,7 @@ module LibItsIicp_Templates {
                    ciClass := p_ciClass 
                } // End of template mw_vciInfoReq
                
            } // End of group recv_
            } // End of group vciInfoReqSendRecv
            
        } // End of group vciInfoReq
        
@@ -419,7 +510,7 @@ module LibItsIicp_Templates {
                 * <li>modifying restrictif template</li>
                 * <li>default altstep</li>
                 * 
                 * @see ISO/WD 24102-4 Clause 7
                 * @see ISO 24102-4 Clause 7
                 * 
                 * Note that all fields are mandatory
                 */
@@ -449,7 +540,7 @@ module LibItsIicp_Templates {
                 * <li>modifying restrictif template</li>
                 * <li>default altstep</li>
                 * 
                 * @see ISO/WD 24102-4 Clause 7
                 * @see ISO 24102-4 Clause 7
                 * 
                 * Note that all fields are mandatory
                 */
+11 −18

File changed.

Preview size limit exceeded, changes collapsed.

Loading