Added T3Doc to LibItsECall_Templates (41546620) · Commits · ITS - Intelligent Transport Systems / ECall_HLAP

ttcn/LibItsECall_Templates.ttcn

+231 −11

Original line number	Diff line number	Diff line
		@@ -22,8 +22,6 @@ module LibItsECall_Templates {
		encode "MSDEncode";
		};

		template ECallMessageUnion ANY_DECODED_ECALL := { decoded := ? }


		/**
		* @desc Same as expandMsd but only works on values
		@@ -44,8 +42,16 @@ module LibItsECall_Templates {
		return p_eCallMessageUnion;
		}

		/**
		* @desc
		*/
		template ECallMessageUnion ANY_DECODED_ECALL := { decoded := ? }

		group configurationTemplates {

		/**
		* @desc Default IVS simulator configuration
		*/
		template (value) ConfigParameters m_defaultIVSSimulatorConfiguration := {
		mode := IVS,
		t3Timer := 2.0,
		@@ -61,6 +67,9 @@ module LibItsECall_Templates {
		simulateCrcError := false
		}

		/**
		* @desc Default PSAP simulator configuration
		*/
		template (value) ConfigParameters m_defaultPsapSimulatorConfiguration := {
		mode := PSAP,
		t4Timer := 2.0,
		@@ -85,34 +94,58 @@ module LibItsECall_Templates {

		group anyEventTemplates {

		/**
		* @desc Receive template for any ConfigChanged event
		*/
		template Event mw_anyConfigChanged := {
		configChanged := ?
		}

		/**
		* @desc Receive template for any CallOutgoing event
		*/
		template Event mw_anyCallOutgoing := {
		callOutgoing := ?
		}

		/**
		* @desc Receive template for any InbandNackSent event
		*/
		template Event mw_anyInbandNackSent := {
		inbandNackSent := ?
		}

		/**
		* @desc Receive template for any ConfigChanged event
		*/
		template Event mw_anyInbandSendSignalReceived := {
		inbandSendSignalReceived := ?
		}

		/**
		* @desc Receive template for any CallRejected event
		*/
		template Event mw_anyCallRejected := {
		callRejected := ?
		}

		/**
		* @desc Receive template for any CallAborted event
		*/
		template Event mw_anyCallAborted := {
		callAborted := ?
		}

		/**
		* @desc Receive template for any CallHangUp event
		*/
		template Event mw_anyCallHangUp := {
		callHangUp := ?
		}

		/**
		* @desc Receive template for any TimerExpired event
		*/
		template Event mw_anyTimerExpired := {
		timerExpired := ?
		}
		@@ -120,7 +153,10 @@ module LibItsECall_Templates {
		} // end anyEventTemplates

		/**
		* @desc Configuration template for simulator IVS mode
		* @desc Receive template for ConfigurationChanged event (IVS mode)
		* @param p_worker Target worker process
		* @param p_time Event timestamp
		* @param p_parameters Expected configuration parameters
		*/
		template Event mw_ivsConfigChanged (
		template(present) integer p_worker,
		@@ -156,7 +192,10 @@ module LibItsECall_Templates {
		}

		/**
		* @desc Configuration template for simulator PSAP mode
		* @desc Receive template for ConfigurationChanged event (PSAP mode)
		* @param p_worker Target worker process
		* @param p_time Event timestamp
		* @param p_parameters Expected configuration parameters
		*/
		template Event mw_psapConfigChanged (
		template(present) integer p_worker,
		@@ -191,6 +230,12 @@ module LibItsECall_Templates {
		}
		}

		/**
		* @desc Receive template for InbandMsdReceived event
		* @param p_worker Target worker process
		* @param p_time Event timestamp
		* @param p_eCallMessage Received eCall message
		*/
		template Event mw_inbandMsdReceived (
		template(present) integer p_worker,
		template(present) charstring p_time := ?,
		@@ -203,6 +248,12 @@ module LibItsECall_Templates {
		}
		}

		/**
		* @desc Receive template for InbandLlAckSent event
		* @param p_worker Target worker process
		* @param p_time Event timestamp
		* @param p_count
		*/
		template Event mw_inbandLlAckSent (
		template(present) integer p_worker,
		template(present) charstring p_time := ?,
		@@ -215,6 +266,13 @@ module LibItsECall_Templates {
		}
		}

		/**
		* @desc Receive template for InbandLlAckReceived event
		* @param p_worker Target worker process
		* @param p_time Event timestamp
		* @param p_count
		* @param p_reliable
		*/
		template Event mw_inbandLlAckReceived (
		template(present) integer p_worker,
		template(present) charstring p_time := ?,
		@@ -229,6 +287,13 @@ module LibItsECall_Templates {
		}
		}

		/**
		* @desc Receive template for InbandAlAckSent event
		* @param p_worker Target worker process
		* @param p_time Event timestamp
		* @param p_count
		* @param p_val Sent AL Ack value
		*/
		template Event mw_inbandAlAckSent (
		template(present) integer p_worker,
		template(present) charstring p_time := ?,
		@@ -243,6 +308,14 @@ module LibItsECall_Templates {
		}
		}

		/**
		* @desc Receive template for InbandAlAckReceived event
		* @param p_worker Target worker process
		* @param p_time Event timestamp
		* @param p_count
		* @param p_val Received AL Ack value
		* @param p_reliable
		*/
		template Event mw_inbandAlAckReceived (
		template(present) integer p_worker,
		template(present) charstring p_time := ?,
		@@ -259,6 +332,13 @@ module LibItsECall_Templates {
		}
		}

		/**
		* @desc Receive template for InbandStateChanged event
		* @param p_worker Target worker process
		* @param p_time Event timestamp
		* @param p_fromState Previous state (OFF, HALF, FULL)
		* @param p_toState Current state (OFF, HALF, FULL)
		*/
		template Event mw_inbandStateChanged (
		template(present) integer p_worker,
		template(present) charstring p_time := ?,
		@@ -273,6 +353,11 @@ module LibItsECall_Templates {
		}
		}

		/**
		* @desc Receive template for InbandSendSignalReceived event
		* @param p_worker Target worker process
		* @param p_time Event timestamp
		*/
		template Event mw_inbandSendSignalReceived (
		template(present) integer p_worker,
		template(present) charstring p_time := ?
		@@ -283,6 +368,12 @@ module LibItsECall_Templates {
		}
		}

		/**
		* @desc Receive template for InbandNackSent event
		* @param p_worker Target worker process
		* @param p_time Event timestamp
		* @param p_count
		*/
		template Event mw_inbandNackSent (
		template(present) integer p_worker,
		template(present) charstring p_time := ?,
		@@ -295,6 +386,12 @@ module LibItsECall_Templates {
		}
		}

		/**
		* @desc Receive template for InbanNackReceived event
		* @param p_worker Target worker process
		* @param p_time Event timestamp
		* @param p_count
		*/
		template Event mw_inbandNackReceived (
		template(present) integer p_worker,
		template(present) charstring p_time := ?,
		@@ -307,6 +404,12 @@ module LibItsECall_Templates {
		}
		}

		/**
		* @desc Receive template for CallCancelled event
		* @param p_worker Target worker process
		* @param p_time Event timestamp
		* @param p_callRef INTERNAL/EXTERNAL
		*/
		template Event mw_callCanceled (
		template(present) integer p_worker,
		template(present) charstring p_time := ?,
		@@ -319,6 +422,14 @@ module LibItsECall_Templates {
		}
		}

		/**
		* @desc Receive template for CallIncoming event
		* @param p_worker Target worker process
		* @param p_time Event timestamp
		* @param p_from Caller ID
		* @param p_to Calling ID
		* @param p_callRef INTERNAL/EXTERNAL
		*/
		template Event mw_callIncoming (
		template(present) integer p_worker,
		template(present) charstring p_time,
		@@ -335,6 +446,14 @@ module LibItsECall_Templates {
		}
		}

		/**
		* @desc Receive template for CallOutgoing event
		* @param p_worker Target worker process
		* @param p_time Event timestamp
		* @param p_from Caller ID
		* @param p_to Calling ID
		* @param p_callRef INTERNAL/EXTERNAL
		*/
		template Event mw_callOutgoing (
		template(present) integer p_worker,
		template(present) charstring p_time,
		@@ -351,6 +470,12 @@ module LibItsECall_Templates {
		}
		}

		/**
		* @desc Receive template for CallEstablished event
		* @param p_worker Target worker process
		* @param p_time Event timestamp
		* @param p_callRef INTERNAL/EXTERNAL
		*/
		template Event mw_callEstablished (
		template(present) integer p_worker,
		template(present) charstring p_time := ?,
		@@ -363,6 +488,12 @@ module LibItsECall_Templates {
		}
		}

		/**
		* @desc Receive template for CallRejected event
		* @param p_worker Target worker process
		* @param p_time Event timestamp
		* @param p_callRef INTERNAL/EXTERNAL
		*/
		template Event mw_callRejected (
		template(present) integer p_worker,
		template(present) charstring p_time := ?,
		@@ -375,6 +506,12 @@ module LibItsECall_Templates {
		}
		}

		/**
		* @desc Receive template for CallHangUp event
		* @param p_worker Target worker process
		* @param p_time Event timestamp
		* @param p_callRef INTERNAL/EXTERNAL
		*/
		template Event mw_callHangUp (
		template(present) integer p_worker,
		template(present) charstring p_time := ?,
		@@ -387,6 +524,13 @@ module LibItsECall_Templates {
		}
		}

		/**
		* @desc Receive template for CallAborted event
		* @param p_worker Target worker process
		* @param p_time Event timestamp
		* @param p_callRef INTERNAL/EXTERNAL
		* @param p_reason Abortion description
		*/
		template Event mw_callAborted (
		template(present) integer p_worker,
		template(present) charstring p_time,
		@@ -401,6 +545,11 @@ module LibItsECall_Templates {
		}
		}

		/**
		* @desc Receive template for CallVoiceConnectionEstablished event
		* @param p_worker Target worker process
		* @param p_time Event timestamp
		*/
		template Event mw_callVoiceConnectionEstablished (
		template(present) integer p_worker,
		template(present) charstring p_time := ?
		@@ -411,6 +560,13 @@ module LibItsECall_Templates {
		}
		}

		/**
		* @desc Receive template for InbandStartSignalReceived event
		* @param p_worker Target worker process
		* @param p_time Event timestamp
		* @param p_count
		* @param p_reliable
		*/
		template Event mw_inbandStartSignalReceived (
		template(present) integer p_worker,
		template(present) charstring p_time := ?,
		@@ -425,6 +581,13 @@ module LibItsECall_Templates {
		}
		}

		/**
		* @desc Receive template for TimerExpired event
		* @param p_worker Target worker process
		* @param p_time Event timestamp
		* @param p_name Timer name
		* @param p_val Timer value in seconds
		*/
		template Event mw_timerExpired (
		template(present) integer p_worker,
		template(present) charstring p_time := ?,
		@@ -439,10 +602,18 @@ module LibItsECall_Templates {
		}
		}

		/**
		* @desc Receive template for T7 expiration event
		* @param p_worker Target worker process
		*/
		template Event mw_t7Expired(
		template(present) integer p_worker
		) := mw_timerExpired(p_worker, ?, "t7", ?);

		/**
		* @desc Receveive template for T8 expiration event
		* @param p_worker Target worker process
		*/
		template Event mw_t8Expired(
		template(present) integer p_worker
		) := mw_timerExpired(p_worker, ?, "t8", ?);
		@@ -451,6 +622,11 @@ module LibItsECall_Templates {

		group commandTemplates {

		/** Generic send template for SetConfig command
		* @desc
		* @param p_worker Target worker process
		* @param p_parameters
		*/
		template (value) SetConfigCmd m_setConfig (
		integer p_worker,
		template(value) ConfigParameters p_parameters
		@@ -459,6 +635,11 @@ module LibItsECall_Templates {
		parameters := p_parameters
		}

		/**
		* @desc Send template for InbandModelState configuration command
		* @param p_worker Target worker process
		* @param p_state Inband model state
		*/
		template (value) SetConfigCmd m_setInbandModelState (
		integer p_worker,
		ModemStateType p_state
		@@ -469,6 +650,12 @@ module LibItsECall_Templates {
		}
		}

		/**
		* @desc Send template for AutomaticAlAck configuration command
		* @param p_worker Target worker process
		* @param p_automaticAlAck Automatic/Manual mode for AL Ack
		* @param p_alAckValue AL Ack value for automatic mode
		*/
		template (value) SetConfigCmd m_setAutomaticAlAck (
		integer p_worker,
		boolean p_automaticAlAck := true,
		@@ -481,6 +668,10 @@ module LibItsECall_Templates {
		}
		}

		/**
		* @desc Send template for CallAccept command
		* @param p_worker Target worker process
		*/
		template (value) CallAcceptCmd m_callAccept (
		integer p_worker
		) := {
		@@ -488,12 +679,21 @@ module LibItsECall_Templates {
		callRef := EXTERNAL
		}

		/**
		* @desc Send template for CallHangUp command
		* @param p_worker Target worker process
		*/
		template (value) CallHangUpCmd m_callHangUpC (
		integer p_worker
		) := {
		worker := p_worker
		}

		/**
		* @desc Send template for CallRejectBus command
		* @param p_worker Target worker process
		* @param p_callRef EXTERNAL
		*/
		template (value) CallRejectBusyCmd m_callRejectBusy (
		template(value) integer p_worker,
		template(value) CallRefType p_callRef := EXTERNAL
		@@ -502,6 +702,12 @@ module LibItsECall_Templates {
		callRef := p_callRef
		}

		/**
		* @desc Send template for CallCreate command
		* @param p_worker Target worker process
		* @param p_to Call destination
		* @param p_callRef EXTERNAL
		*/
		template (value) CallCreateCmd m_callCreate (
		template(value) integer p_worker,
		template(value) charstring p_to,
		@@ -512,6 +718,11 @@ module LibItsECall_Templates {
		callRef := p_callRef
		}

		/**
		* @desc Send template for CallCancel command
		* @param p_worker Target worker process
		* @param p_callRef EXTERNAL
		*/
		template (value) CallCancelCmd m_callCancel (
		template(value) integer p_worker,
		template(value) CallRefType p_callRef := EXTERNAL
		@@ -520,12 +731,21 @@ module LibItsECall_Templates {
		callRef := p_callRef
		}

		/**
		* @desc Send template for InbandRequestMsd command
		* @param p_worker Target worker process
		*/
		template (value) InbandRequestMsdCmd m_inbandRequestMsd (
		template(value) integer p_worker
		) := {
		worker := p_worker
		}

		/**
		* @desc Send template for InbandSendAlAck command
		* @param p_worker Target worker process
		* @param p_val AL Ack value to be sent
		*/
		template (value) InbandSendAlAckCmd m_inbandSendAlAck (
		integer p_worker,
		AckValueType p_val := c_positiveAlAck

ttcn/LibItsECall_TypesAndValues.ttcn

+1 −1

Original line number	Diff line number	Diff line
		@@ -260,7 +260,7 @@ module LibItsECall_TypesAndValues {
		* @member worker Worker process that generated this event
		* @member time Event timestamp
		* @member count
		* @member val
		* @member val Sent AL Ack value
		* @remark mode: PSAP
		*/
		type record InbandAlAckSentEvent {