/**
 *  @author     ETSI / STF517
 *  @version    $Url: https://oldforge.etsi.org/svn/LibIts/tags/20170222_STF527_Final/ttcn/IVIM/LibItsIvim_TypesAndValues.ttcn $
 *              $Id: LibItsIvim_TypesAndValues.ttcn,v 1.4 2019/01/02 14:14:11 dte Exp $
 *  @desc       Module containing type and value definitions for IVIM
 *  @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 LibItsIvim_TypesAndValues {
    
    // LibCommon
    import from LibCommon_DataStrings all;
    import from LibCommon_BasicTypesAndValues all;
    
    // LibIts
    import from IVIM_PDU_Descriptions language "ASN.1:1997" all;
    import from IVI language "ASN.1:1997" all;
    import from ITS_Container language "ASN.1:1997" all;
    import from CITSapplMgmtIDs language "ASN.1:1997" all;
    
    group actionTypes {
        
        /**
         * @desc Indication of whether event cancellation has to be raised by the test system or iut
         */
        type enumerated Trigger {
            e_ets(0),
            e_iut(1)
        }
        
    } // End ofgroup actionTypes
    
    group ivimConstants {
        
        const TimestampIts c_repetition_interval_deactivated := 0;
        const TimestampIts c_duration_2sec := 2;
        const TimestampIts c_duration_4sec := 4;
        const TimestampIts c_duration_6sec := 6;
        
        type record of float Times;
    } // End ofgroup ivimConstants
    
    group otherTypes {
        
        /**
         * @desc List of UtIvimTriggers used in behaviours 
         */
        type record of UtIvimTrigger UtIvimTriggerList;
        
        /**
         * @desc List of IviIdentificationNumbers used in behaviours 
         */
        type record of IviIdentificationNumber IviIdentificationNumberList;
        
        /**
         * @desc List of ZoneIds
         */
        type record of Zid ZidList;
        
        /**
         * @desc List of RelavanceZoneIds
         */
        type record of Zid RelavanceZidList;
        
        /**
         * @desc List of DetectionZoneIds
         */
        type record of Zid DetectionZidList;
        
        /**
         * @desc List of DriverAwarenesZoneIds
         */
        type record of Zid DriverAwarenesZidList;
        
    }
    
    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 UtIvimInitialize {
        Oct8 hashedId8 
        } with {
        variant "FIELDORDER(msb)"
        }

    /**
     * @desc Upper Tester results message of the IVIM IUT
     * @member utIvimInitialize             -
     * @member utIvimTriggerResult          -
     * @member utIvimUpdateResult,          -
     * @member utIvimTerminationResult   -
     */
    type union UtIvimResults {
      boolean utIvimInitializeResult,
        UtIvimTriggerResult utIvimTriggerResult,
        UtIvimUpdateResult utIvimUpdateResult,
        boolean utIvimTerminationResult
      } with {
      variant ""
      } // End of type UtIvimResults
	
        /**
         * @desc Upper Tester message to request triggering of an event at IUT 
         */
        type record UtIvimTrigger {
            TimestampIts validFrom optional,
            TimestampIts validTo optional,
            TimestampIts repetitionInterval optional,
            ZidList zoneIds optional,
            LanePosition laneNumber optional,
            RelavanceZidList relavanceZoneIds optional,
            DetectionZidList detectionZoneIds optional,
            DriverAwarenesZidList driverAwarenesZoneIds optional,
            VarLengthNumber itsRrid optional,
            Direction directionGic optional,
            integer layoutId optional
        } with {
          variant "FIELDORDER(msb)"
        }
        
        /**
         * @desc Upper Tester result message of request of triggering of an event at IUT 
         */
        type record UtIvimTriggerResult {
            boolean result,
            IviIdentificationNumber iviIdentificationNumber
        } with {
          variant "FIELDORDER(msb)"
        }
        
        /**
         * @desc Upper Tester message to update an event at IUT 
         */
        type record UtIvimUpdate {
            IviIdentificationNumber iviIdentificationNumber,
            TimestampIts validFrom optional,
            TimestampIts validTo optional,
            TimestampIts timeStamp optional,
            IVIManagementContainer.connectedIviStructures connectedIviStructures optional
        } with {
          variant "FIELDORDER(msb)"
        }
        
        /**
         * @desc Upper Tester result message of an update request of an event on Ivim IUT 
         */
        type record UtIvimUpdateResult { 
            boolean result,
            IviIdentificationNumber iviIdentificationNumber
        } with {
          variant "FIELDORDER(msb)"
        }
        
        /**
         * @desc Upper Tester message to request the termination of an event at IUT 
         */
        type record UtIvimTermination {
            IviIdentificationNumber iviIdentificationNumber
        } with {
          variant "FIELDORDER(msb)"
        }
        
        /**
         * @desc Upper Tester result message of termination of an event on Ivim IUT 
         */
        //type boolean UtIvimTerminationResult;

        /**
         * @desc Upper Tester message to check event/status on Ivim IUT 
         */
        type record UtIvimEventInd {
            IVIM iviMsg
        } with {
            encode (iviMsg) "LibItsIvim_asn1"
        }
        
        /**
         * @desc List of Upper Tester messages to check event/status on Ivim IUT 
         */
        type record of UtIvimEventInd UtIvimEventIndList;
        
        /**
         * @desc List of ActionID received in response to the Upper Tester triggered messages
         */
        type record of ActionID UtIvimActionIDList;
        
    }
    with {
        encode "UpperTester"
        variant ""
    }
}
with {
    encode "LibItsIvim"
}