LibItsBtp_TypesAndValues.ttcn

/**
 *  @author   ETSI / STF405
 *  @version  $URL$
 *            $Id$
 *  @desc     Module containing types and values for Basic Transport 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 LibItsBtp_TypesAndValues {

    // LibCommon
    import from LibCommon_BasicTypesAndValues all;
    
    type octetstring BtpRawPayload;
    
    group btpPdus {
     
        /**
         * @desc BTP Packet
         * @see ETSI TS 102 636-5-1 chapter 6
         * @member header
         * @member payload
         */
        type record BtpPacket {
            BtpHeader      header,
            BtpRawPayload  payload optional
        }
        with {
	    variant "FIELDORDER(msb)"
            encode "LibIts_Interface"
        }
        
    } // end btpPdus
    
    group btpHeaders {
        
        /**
         * @desc BTP Header
         * @see ETSI TS 102 636-5-1 chapter 7.1
         * @member btpAHeader
         * @member btpBHeader
         */
        type union BtpHeader {
            BtpAHeader btpAHeader,
            BtpBHeader btpBHeader 
        } with {
	    variant "FIELDORDER(msb)"
	}


        /**
         * @desc BTP-A Header
         * @see ETSI TS 102 636-5-1 chapter 7.2
         * @member destinationPort
         * @member sourcePort
         */        
        type record BtpAHeader {
            BtpPortId destinationPort,
            BtpPortId sourcePort   
        } with {
	    variant "FIELDORDER(msb)"
	}
 

        /**
         * @desc BTP-B Header
         * @see ETSI TS 102 636-5-1 chapter 7.3
         * @member destinationPort
         * @member destinationPortInfo
         */        
        type record BtpBHeader {
            BtpPortId destinationPort,
            BtpPortInfo destinationPortInfo   
        } with {
	    variant "FIELDORDER(msb)"
	}

        
        /**
         * @desc BTP Port ID
         * @see ETSI TS 102 636-5-1 chapter 7.3.2
         */ 
        type UInt16 BtpPortId;

        /**
         * @desc BTP-B Port info
         * @see ETSI TS 102 636-5-1 chapter 7.3.2
         */ 
        type UInt16 BtpPortInfo;
        
    } // end btpHeaders

    group utPrimitives {
        
        group utCommonPrimitives {
            
            /**
             * @desc    UT primitives for BTP
             * @member  btpA      -
             * @member  btpB    -
             */
            type union UtBtpTrigger {
                GenerateBtpA btpA,
                GenerateBtpB btpB
            }
    
//FIXME RGY As discussed, boolean results are replaced by a union of the results
//            type boolean UtBtpTriggerResult;
            type union UtBtpResults {
              boolean utBtpTriggerResult
            }
            type UtBtpResults.utBtpTriggerResult UtBtpTriggerResult;
            
            /**
             * @desc Upper Tester message to request triggering of an BTPA message at IUT 
             */
            type record GenerateBtpA {
                BtpAHeader btpAHeader
            }
                    
            /**
             * @desc Upper Tester message to request triggering of an BTPB message at IUT 
             */
            type record GenerateBtpB {
                BtpBHeader btpBHeader
            }
            
            /**
             * @desc Upper Tester message to check event/status on BTP IUT 
             */    
            type record UtBtpEventInd {
                BtpRawPayload rawPayload
            }
            
            /**
             * @desc List of Upper Tester messages to check event/status on CAM IUT 
             */    
            type record of UtBtpEventInd UtBtpEventIndList;
        }
//        with {
//            encode "LibItsCommon"
//        }
                
        
    } // end utPrimitives
    with {
        encode "UpperTester"
    }
    
} with {
    variant ""
    encode "LibItsGeoNetworking"
}