Newer
Older
* @desc Module containing functions for DENM
*
*/
// LibCommon
import from LibCommon_Sync all;
import from LibCommon_VerdictControl all;
import from LibCommon_Time {
modulepar PX_TNOAC;
function f_sleep
};
// LibIts
import from LibItsCommon_Functions all;
import from LibItsDenm_TestSystem all;
import from LibItsDenm_TypesAndValues all;
import from LibItsDenm_Templates all;
import from ITS_Container language "ASN.1:1997" all;
group utFuntions {
/**
* @desc Requests to bring the IUT in an initial state
* @param p_init The initialisation to trigger.
*/
function f_utInitializeIut(template (value) UtInitialize p_init) runs on ItsDenm {
utPort.send(p_init);
tc_wait.start;
alt {
* @desc Triggers an event from the application layer
function f_utTriggerEvent(template (value) UtTrigger p_event) runs on ItsDenm return ActionID {
var ActionID v_actionId;
[] utPort.receive(UtTriggerResult:?) -> value v_actionId {
* @desc Updates an event at the application layer
* @param p_event The event to update.
function f_utUpdateEvent(template (value) UtUpdate p_event) runs on ItsDenm return ActionID {
var ActionID v_actionId;
[] utPort.receive(UtUpdateResult:?) -> value v_actionId {
[] a_utDefault();
}
return v_actionId;
}
/**
* @desc Terminates an event at the application layer
* @param p_event The event to terminate.
*/
function f_utTerminateEvent(template (value) UtTermination p_event) runs on ItsDenm {
utPort.send(p_event);
alt {
[] utPort.receive(UtTerminationResult:?) {
/**
* @desc Changes the position of the IUT
* @param p_latitude
* @param p_longitude
* @param p_elevation
*/
function f_utChangePosition(template (value) UtChangePosition p_position) runs on ItsDenm {
utPort.send(p_position);
alt {
[] utPort.receive(UtChangePositionResult:?) {
tc_wait.stop;
}
[] a_utDefault();
}
}
/**
* @desc Setups default configuration
*/
map(self:utPort, system:utPort);
map(self:denmPort, system:denmPort);
f_connect4SelfOrClientSync();
} // end f_cfUp
/**
* @desc Deletes default configuration
*/
f_disconnect4SelfOrClientSync();
} // end f_cfDown
group altsteps {
/**
* @desc The base default.
*/
[] denmPort.receive(mw_denmInd(mw_denmPdu(mw_anyDenm))) {
log("*** " & __SCOPE__ & ": INFO: DENM message received in default ***");
log("*** " & __SCOPE__ & ": ERROR: Received an unexpected message ***");
log("*** " & __SCOPE__ & ": INCONC: Timeout while awaiting reaction of the IUT prior to Upper Tester action ***");
f_selfOrClientSyncAndVerdict("error", e_timeout);
log("*** " & __SCOPE__ & ": INCONC: Timeout while awaiting the reception of a message ***");
f_selfOrClientSyncAndVerdict("error", e_timeout);
[] a_shutdown() {
f_poDefault();
f_cfDown();
log("*** " & __SCOPE__ & ": INFO: TEST COMPONENT NOW STOPPING ITSELF! ***");
stop;
}
}
/**
* @desc Default handling the cancellation of an event.
* @param p_trigger Indicates if the cancellation have to be raised by the test system(e_ets)
* or at the application layer of the IUT(e_iut).
* @param p_actionId The action ID of the event to be cancelled
altstep a_cancelEvent(in template (value) Trigger p_trigger, in template (value) ActionID p_actionId)
log("*** " & __SCOPE__ & ": INFO: TEST COMPONENT NOW STOPPING ITSELF! ***");
/**
* TODO
* @desc
*/
altstep a_utDefault() runs on ItsDenm {
var UtEventInd v_event;
[] utPort.receive(UtEventInd:?) -> value v_event {
vc_utEvents[sizeof(vc_utEvents)] := v_event;
repeat;
}
[] utPort.receive {
tc_wait.stop;
log("*** " & __SCOPE__ & ": INFO: Received unexpected UT message from IUT ***");
f_selfOrClientSyncAndVerdict("error", e_error);
}
[] tc_wait.timeout {
log("*** " & __SCOPE__ & ": INFO: Could not receive expected UT message from IUT in time ***");
f_selfOrClientSyncAndVerdict("error", e_timeout);
}
[else] { // Shortcut defaults
repeat;
}
}
} // end group altsteps
group preambles {
/**
* @desc The default preamble.
*/
vc_default := activate(a_default());
}
/**
* @desc Brings the IUT into an initial state.
function f_prInitialState() runs on ItsDenm return FncRetCode {
return v_ret;
}
} // end group preambles
group postambles {
/**
* @desc The default postamble.
*/
var FncRetCode v_ret := e_success;
//empty
}
/**
* @desc Postamble including cancellation of an event.
berge
committed
* @param p_trigger Indicates if the cancellation have to be raised by the test system(e_ets)
* or at the application layer of the IUT(e_iut).
* @param p_actionId The action ID of the event to be cancelled
function f_poCancelEvent(template (value) Trigger p_trigger, template (value) ActionID p_actionId)
f_utTerminateEvent(m_utEventCancellation(p_actionId));
}
f_poDefault();
}
} // end group postambles
group sendFunctions {
/**
* @desc Sends a DEN message
* @param p_sendMsg The DEN message to send.
*/
function f_sendDenMessage(template (value) DecentralizedEnvironmentalNotificationMessage p_denm) runs on ItsDenm return ActionID {
p_denm.management.actionID.sequenceNumber := vc_sequenceNo;
denmPort.send(
m_denmReq(
m_denmPdu(
p_denm
)
)
);
}
} // end sendFunctions
group receiveFunctions {
/**
* @param p_rcvMsg The expected message to be received.
* @param p_rcvdMsg The received message - OUT.
*/
function f_awaitDenMessage(in template (present) DenmInd p_rcvMsg, out DenmInd p_rcvdMsg) runs on ItsDenm {
log("*** " & __SCOPE__ & ": INFO: Timeout while awaiting the reception of a message ***");
f_selfOrClientSyncAndVerdict("error", e_timeout);
}
}
} // end receiveFunctions
group getFunctions {
* @return Default expiry time of DENM events
function f_getIutDefaultEventDuration() return TimestampIts {
group miscellaneousFunctions {
function f_increaseSequenceNumber(in SequenceNumber p_sequenceNumber) return SequenceNumber {
// if maximum number of 65535 reached, reset it to 0
return ((p_sequenceNumber + 1) mod 65536);
}
function f_increaseDataVersion(in DataVersion p_dataVersion) return DataVersion {
// if maximum number of 254 reached, reset it to 0
return ((p_dataVersion + 1) mod 255);
}
} // end group miscellaneousFunctions