| <html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>EPTF_MBT_LGen_Functions - MBT_Applib</title><link rel="stylesheet" type="text/css" href="../styles/main.css"><script language=JavaScript src="../javascript/main.js"></script><script language=JavaScript src="../javascript/prettify.js"></script></head><body class="FramedContentPage" onLoad="NDOnLoad();prettyPrint();"><script language=JavaScript><!-- |
| if (browserType) {document.write("<div class=" + browserType + ">");if (browserVer) {document.write("<div class=" + browserVer + ">"); }}// --></script> |
| |
| <!-- Generated by Natural Docs, version 1.52 --> |
| <!-- http://www.naturaldocs.org --> |
| |
| <!-- saved from url=(0026)http://www.naturaldocs.org --> |
| |
| |
| |
| |
| <div id=Content><div class="CFile"><div class=CTopic id=MainTopic><h1 class=CTitle><a name="EPTF_MBT_LGen_Functions"></a>EPTF_MBT_LGen_Functions</h1><div class=CBody><h4 class=CHeading>Purpose</h4><p>Functions of the MBT Applib</p><h4 class=CHeading>Module depends on</h4><ul><li><a href="EPTF_MBT_LGen_Definitions-ttcn.html#EPTF_MBT_LGen_Definitions" class=LFile id=link21 onMouseOver="ShowTip(event, 'tt21', 'link21')" onMouseOut="HideTip('tt21')">EPTF_MBT_LGen_Definitions</a></li><li><EPTF_CLL_Logging_Definitions></li><li><EPTF_CLL_Logging_Functions></li><li><EPTF_CLL_Common_Definitions></li><li><EPTF_CLL_Variable_Definitions></li><li><EPTF_CLL_Variable_Functions></li><li><EPTF_CLL_Scheduler_Definitions></li><li><EPTF_CLL_Base_Definitions></li><li><EPTF_CLL_Base_Functions></li><li><EPTF_CLL_LGenBase_ConfigDefinitions></li><li><EPTF_CLL_LGenBase_ConfigFunctions></li><li><EPTF_CLL_LGenBase_Functions></li><li><EPTF_CLL_LGenBase_Definitions></li><li><EPTF_CLL_LGenBase_EventHandlingFunctions></li><li><EPTF_CLL_LGenBase_StepFunctions></li><li><EPTF_CLL_RBTScheduler_Functions></li><li><EPTF_CLL_Semaphore_Functions></li></ul><!--START_ND_SUMMARY--><div class=Summary><div class=STitle>Summary</div><div class=SBorder><table border=0 cellspacing=0 cellpadding=0 class=STable><tr class="SMain"><td class=SEntry><a href="#EPTF_MBT_LGen_Functions" >EPTF_MBT_LGen_Functions</a></td><td class=SDescription>Functions of the MBT Applib</td></tr><tr class="SFunction SMarked"><td class=SEntry><a href="#f_EPTF_MBT_init" id=link1 onMouseOver="ShowTip(event, 'tt1', 'link1')" onMouseOut="HideTip('tt1')">f_EPTF_MBT_init</a></td><td class=SDescription>Function to initialize MBT behaviour</td></tr><tr class="SFunction"><td class=SEntry><a href="#f_EPTF_MBT_cleanup_CT" id=link2 onMouseOver="ShowTip(event, 'tt2', 'link2')" onMouseOut="HideTip('tt2')">f_EPTF_MBT_cleanup_CT</a></td><td class=SDescription>Cleanup function of the MBT Applib</td></tr><tr class="SFunction SMarked"><td class=SEntry><a href="#f_EPTF_MBT_declareEvents" id=link3 onMouseOver="ShowTip(event, 'tt3', 'link3')" onMouseOut="HideTip('tt3')">f_EPTF_MBT_declareEvents</a></td><td class=SDescription>Register the EVents used by the MBT AppLib</td></tr><tr class="SFunction"><td class=SEntry><a href="#f_EPTF_MBT_declareTestSteps" id=link4 onMouseOver="ShowTip(event, 'tt4', 'link4')" onMouseOut="HideTip('tt4')">f_EPTF_MBT_declareTestSteps</a></td><td class=SDescription>Register the TestSteps used by the MBT AppLib</td></tr><tr class="SFunction SMarked"><td class=SEntry><a href="#f_EPTF_MBT_bindEntity" id=link5 onMouseOver="ShowTip(event, 'tt5', 'link5')" onMouseOut="HideTip('tt5')">f_EPTF_MBT_bindEntity</a></td><td class=SDescription>Bind function of the MBT AppLib</td></tr><tr class="SFunction"><td class=SEntry><a href="#f_EPTF_MBT_unbindEntity" id=link6 onMouseOver="ShowTip(event, 'tt6', 'link6')" onMouseOut="HideTip('tt6')">f_EPTF_MBT_unbindEntity</a></td><td class=SDescription>Unbind function of the MBT AppLib</td></tr><tr class="SFunction SMarked"><td class=SEntry><a href="#f_EPTF_MBT_resetEntity" id=link7 onMouseOver="ShowTip(event, 'tt7', 'link7')" onMouseOut="HideTip('tt7')">f_EPTF_MBT_resetEntity</a></td><td class=SDescription>Reset function of the MBT AppLib</td></tr><tr class="SFunction"><td class=SEntry><a href="#f_EPTF_MBT_TestStep_invokeTestStep" id=link8 onMouseOver="ShowTip(event, 'tt8', 'link8')" onMouseOut="HideTip('tt8')">f_EPTF_MBT_TestStep_invokeTestStep</a></td><td class=SDescription>General Purpose wrapper TestStep to select the Proper TestStep based on its actual parameters and invokes it. </td></tr><tr class="SFunction SMarked"><td class=SEntry><a href="#f_EPTF_MBT_TestStep_sendUserResponse" id=link9 onMouseOver="ShowTip(event, 'tt9', 'link9')" onMouseOut="HideTip('tt9')">f_EPTF_MBT_TestStep_sendUserResponse</a></td><td class=SDescription>TestStep function to generate the User response,. </td></tr><tr class="SFunction"><td class=SEntry><a href="#f_EPTF_MBT_TestStep_invokeUserFunction" id=link10 onMouseOver="ShowTip(event, 'tt10', 'link10')" onMouseOut="HideTip('tt10')">f_EPTF_MBT_TestStep_invokeUserFunction</a></td><td class=SDescription>TestStep function to invoke user specific function</td></tr><tr class="SFunction SMarked"><td class=SEntry><a href="#f_EPTF_MBT_Listener_catchEntityEvents" id=link11 onMouseOver="ShowTip(event, 'tt11', 'link11')" onMouseOut="HideTip('tt11')">f_EPTF_MBT_Listener_catchEntityEvents</a></td><td class=SDescription>This is a listener to catch all entity level events. </td></tr><tr class="SFunction"><td class=SEntry><a href="#f_EPTF_MBT_Listener_catchGenericEvents" id=link12 onMouseOver="ShowTip(event, 'tt12', 'link12')" onMouseOut="HideTip('tt12')">f_EPTF_MBT_Listener_catchGenericEvents</a></td><td class=SDescription>This is a listener to catch all generic level events. </td></tr><tr class="SFunction SMarked"><td class=SEntry><a href="#as_EPTF_MBT_PCO_Handler" id=link13 onMouseOver="ShowTip(event, 'tt13', 'link13')" onMouseOut="HideTip('tt13')">as_EPTF_MBT_PCO_Handler</a></td><td class=SDescription>EventHandler of the MBT AppLib</td></tr><tr class="SFunction"><td class=SEntry><a href="#f_EPTF_MBT_initLGenFsm" id=link14 onMouseOver="ShowTip(event, 'tt14', 'link14')" onMouseOut="HideTip('tt14')">f_EPTF_MBT_initLGenFsm</a></td><td class=SDescription>This function inits the MBT FSM</td></tr><tr class="SFunction SMarked"><td class=SEntry><a href="#f_EPTF_MBT_Tester_init" id=link15 onMouseOver="ShowTip(event, 'tt15', 'link15')" onMouseOut="HideTip('tt15')">f_EPTF_MBT_Tester_init</a></td><td class=SDescription>This function inits the EPTF_MBT_Tester_CT</td></tr><tr class="SFunction"><td class=SEntry><a href="#f_MBT_execute" id=link16 onMouseOver="ShowTip(event, 'tt16', 'link16')" onMouseOut="HideTip('tt16')">f_MBT_execute</a></td><td class=SDescription>This function executes a test step on specifid FSM (which must run the FSM_MBT) FSM. </td></tr><tr class="SFunction SMarked"><td class=SEntry><a href="#f_MBT_waitFor" id=link17 onMouseOver="ShowTip(event, 'tt17', 'link17')" onMouseOut="HideTip('tt17')">f_MBT_waitFor</a></td><td class=SDescription>This function waits for specified EPTF event to arrive. </td></tr><tr class="SFunction"><td class=SEntry><a href="#f_MBT_dispatch" id=link18 onMouseOver="ShowTip(event, 'tt18', 'link18')" onMouseOut="HideTip('tt18')">f_MBT_dispatch</a></td><td class=SDescription>This function sends an EPTF event to an FSM.</td></tr><tr class="SFunction SMarked"><td class=SEntry><a href="#f_MBT_activateFsm" id=link19 onMouseOver="ShowTip(event, 'tt19', 'link19')" onMouseOut="HideTip('tt19')">f_MBT_activateFsm</a></td><td class=SDescription>This function activates an FSM on an entity.</td></tr><tr class="SFunction"><td class=SEntry><a href="#f_convert_FsmAddr2TestStepArgs" id=link20 onMouseOver="ShowTip(event, 'tt20', 'link20')" onMouseOut="HideTip('tt20')">f_convert_FsmAddr2TestStepArgs</a></td><td class=SDescription>Utility function to convert an FsmAddr address to a TestStepArgs value.</td></tr></table></div></div><!--END_ND_SUMMARY--></div></div></div> |
| |
| <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="f_EPTF_MBT_init"></a>f_EPTF_MBT_init</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "colspan=6>function f_EPTF_MBT_init (</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>charstring </td><td class="PParameter prettyprint " nowrap>pl_selfName,</td><td class="PDefaultValuePrefix prettyprint "> </td><td class="PDefaultValue prettyprint " width=100%></td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>integer </td><td class="PParameter prettyprint " nowrap>pl_selfId,</td><td class="PDefaultValuePrefix prettyprint "> </td><td class="PDefaultValue prettyprint " width=100%></td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>charstring </td><td class="PParameter prettyprint " nowrap>pl_entityNamePrefix,</td><td class="PDefaultValuePrefix prettyprint "> </td><td class="PDefaultValue prettyprint " width=100%></td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in integer </td><td class="PType prettyprint " nowrap>pl_numEntities </td><td class="PParameter prettyprint " nowrap>:</td><td class="PDefaultValuePrefix prettyprint "> = </td><td class="PDefaultValue prettyprint " width=100%> 0,</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in EPTF_LGenBase_BehaviorContextBinder_FT </td><td class="PType prettyprint " nowrap>pl_bind </td><td class="PParameter prettyprint " nowrap>:</td><td class="PDefaultValuePrefix prettyprint "> = </td><td class="PDefaultValue prettyprint " width=100%> refers(f_EPTF_MBT_bindEntity),</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in EPTF_LGenBase_BehaviorContextHandler_FT </td><td class="PType prettyprint " nowrap>pl_reset </td><td class="PParameter prettyprint " nowrap>:</td><td class="PDefaultValuePrefix prettyprint "> = </td><td class="PDefaultValue prettyprint " width=100%> refers(f_EPTF_MBT_resetEntity),</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in EPTF_LGenBase_BehaviorContextHandler_FT </td><td class="PType prettyprint " nowrap>pl_unbind </td><td class="PParameter prettyprint " nowrap>:</td><td class="PDefaultValuePrefix prettyprint "> = </td><td class="PDefaultValue prettyprint " width=100%> refers(f_EPTF_MBT_unbindEntity)</td></tr><tr><td class="PAfterParameters prettyprint "colspan=6>) runs on EPTF_MBT_LGen_CT</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>Function to initialize MBT behaviour</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>pl_selfName</td><td class=CDLDescription><b>in</b> <b>charstring</b> - the components self name</td></tr><tr><td class=CDLEntry>pl_selfId</td><td class=CDLDescription><b>in</b> <b>integer</b> - component self id</td></tr><tr><td class=CDLEntry>pl_entityNamePrefix</td><td class=CDLDescription><b>in</b> <b>charstring</b> - entity name prefix</td></tr><tr><td class=CDLEntry>pl_numEntities</td><td class=CDLDescription><b>in</b> <b>integer</b> - number of entities</td></tr><tr><td class=CDLEntry>pl_bind</td><td class=CDLDescription><b>in</b> <EPTF_LGenBase_BehaviorContextBinder_FT> - behaviour context bind callback function</td></tr><tr><td class=CDLEntry>pl_reset</td><td class=CDLDescription><b>in</b> <EPTF_LGenBase_BehaviorContextHandler_FT> - behaviour context reset callback function</td></tr><tr><td class=CDLEntry>pl_unbind</td><td class=CDLDescription><b>in</b> <EPTF_LGenBase_BehaviorContextHandler_FT> - behaviour context unbind callback function</td></tr></table><h4 class=CHeading>Return Value</h4><p>-</p><h4 class=CHeading>Errors</h4><p>-</p><h4 class=CHeading>Detailed Comments</h4><p>-</p></div></div></div> |
| |
| <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="f_EPTF_MBT_cleanup_CT"></a>f_EPTF_MBT_cleanup_CT</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">function f_EPTF_MBT_cleanup_CT() runs on EPTF_MBT_LGen_CT</td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>Cleanup function of the MBT Applib</p><h4 class=CHeading>Parameters</h4><p>-</p><h4 class=CHeading>Return Value</h4><p>-</p><h4 class=CHeading>Errors</h4><p>-</p><h4 class=CHeading>Detailed Comments</h4><p>Unmaps the TestPorts from teh System</p></div></div></div> |
| |
| <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="f_EPTF_MBT_declareEvents"></a>f_EPTF_MBT_declareEvents</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">function f_EPTF_MBT_declareEvents() runs on EPTF_MBT_LGen_CT</td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>Register the EVents used by the MBT AppLib</p><h4 class=CHeading>Parameters</h4><p>-</p><h4 class=CHeading>Return Value</h4><p>-</p><h4 class=CHeading>Errors</h4><p>-</p><h4 class=CHeading>Detailed Comments</h4><p>-</p></div></div></div> |
| |
| <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="f_EPTF_MBT_declareTestSteps"></a>f_EPTF_MBT_declareTestSteps</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">function f_EPTF_MBT_declareTestSteps() runs on EPTF_MBT_LGen_CT</td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>Register the TestSteps used by the MBT AppLib</p><h4 class=CHeading>Parameters</h4><p>-</p><h4 class=CHeading>Return Value</h4><p>-</p><h4 class=CHeading>Errors</h4><p>-</p><h4 class=CHeading>Detailed Comments</h4><p>-</p></div></div></div> |
| |
| <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="f_EPTF_MBT_bindEntity"></a>f_EPTF_MBT_bindEntity</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "colspan=4>function f_EPTF_MBT_bindEntity(</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>integer </td><td class="PParameter prettyprint " nowrap width=100%>pl_eIdx</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MBT_LGen_CT return EPTF_IntegerList</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>Bind function of the MBT AppLib</p><h4 class=CHeading>Parameters</h4><p>-</p><h4 class=CHeading>Return Value</h4><p>-</p><h4 class=CHeading>Errors</h4><p>-</p><h4 class=CHeading>Detailed Comments</h4><p>-</p></div></div></div> |
| |
| <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="f_EPTF_MBT_unbindEntity"></a>f_EPTF_MBT_unbindEntity</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>function f_EPTF_MBT_unbindEntity(</td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>integer </td><td class="PParameter prettyprint " nowrap>pl_eIdx</td><td class="PAfterParameters prettyprint "nowrap>) runs on EPTF_MBT_LGen_CT</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>Unbind function of the MBT AppLib</p><h4 class=CHeading>Parameters</h4><p>-</p><h4 class=CHeading>Return Value</h4><p>-</p><h4 class=CHeading>Errors</h4><p>-</p><h4 class=CHeading>Detailed Comments</h4><p>-</p></div></div></div> |
| |
| <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="f_EPTF_MBT_resetEntity"></a>f_EPTF_MBT_resetEntity</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>function f_EPTF_MBT_resetEntity(</td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>integer </td><td class="PParameter prettyprint " nowrap>pl_eIdx</td><td class="PAfterParameters prettyprint "nowrap>) runs on EPTF_MBT_LGen_CT</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>Reset function of the MBT AppLib</p><h4 class=CHeading>Parameters</h4><p>-</p><h4 class=CHeading>Return Value</h4><p>-</p><h4 class=CHeading>Errors</h4><p>-</p><h4 class=CHeading>Detailed Comments</h4><p>-</p></div></div></div> |
| |
| <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="f_EPTF_MBT_TestStep_invokeTestStep"></a>f_EPTF_MBT_TestStep_invokeTestStep</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "colspan=4>function f_EPTF_MBT_TestStep_invokeTestStep(</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>EPTF_LGenBase_TestStepArgs </td><td class="PParameter prettyprint " nowrap width=100%>pl_ptr</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MBT_LGen_CT</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>General Purpose wrapper TestStep to select the Proper TestStep based on its actual parameters and invokes it. Otherwise generates a log&console statement</p><h4 class=CHeading>Parameters</h4><p>in EPTF_LGenBase_TestStepArgs pl_ptr</p><h4 class=CHeading>Return Value</h4><p>-</p><h4 class=CHeading>Errors</h4><p>-</p><h4 class=CHeading>Detailed Comments</h4><p>-</p></div></div></div> |
| |
| <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="f_EPTF_MBT_TestStep_sendUserResponse"></a>f_EPTF_MBT_TestStep_sendUserResponse</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "colspan=4>function f_EPTF_MBT_TestStep_sendUserResponse(</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>EPTF_LGenBase_TestStepArgs </td><td class="PParameter prettyprint " nowrap width=100%>pl_ptr</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MBT_LGen_CT</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>TestStep function to generate the User response,. It shall be invoked in case of the unhandled events (FSM description) based on the generated event it sends back a response towards the Tester component</p><h4 class=CHeading>Parameters</h4><p>in EPTF_LGenBase_TestStepArgs pl_ptr</p><h4 class=CHeading>Return Value</h4><p>-</p><h4 class=CHeading>Errors</h4><p>-</p><h4 class=CHeading>Detailed Comments</h4><p>-</p></div></div></div> |
| |
| <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="f_EPTF_MBT_TestStep_invokeUserFunction"></a>f_EPTF_MBT_TestStep_invokeUserFunction</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "colspan=4>function f_EPTF_MBT_TestStep_invokeUserFunction(</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>EPTF_LGenBase_TestStepArgs </td><td class="PParameter prettyprint " nowrap width=100%>pl_ptr</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MBT_LGen_CT</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>TestStep function to invoke user specific function</p><h4 class=CHeading>Parameters</h4><p>in EPTF_LGenBase_TestStepArgs pl_ptr</p><h4 class=CHeading>Return Value</h4><p>-</p><h4 class=CHeading>Errors</h4><p>-</p><h4 class=CHeading>Detailed Comments</h4><p>It seraches for the user declared function basedon its name (stored in a component variable) and invokes it.)</p></div></div></div> |
| |
| <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="f_EPTF_MBT_Listener_catchEntityEvents"></a>f_EPTF_MBT_Listener_catchEntityEvents</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "colspan=3>function f_EPTF_MBT_Listener_catchEntityEvents(</td></tr><tr><td> </td><td class="PType prettyprint " nowrap>EPTF_LGenBase_ReportedEventDescriptor </td><td class="PParameter prettyprint " nowrap width=100%>pl_event,</td></tr><tr><td> </td><td class="PType prettyprint " nowrap>EPTF_IntegerList </td><td class="PParameter prettyprint " nowrap width=100%>pl_listenerArgs</td></tr><tr><td class="PAfterParameters prettyprint "colspan=3>) runs on EPTF_MBT_LGen_CT</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>This is a listener to catch all entity level events. Because unhandled events in the FSM descriptor can catch only FSM level events.</p><h4 class=CHeading>Parameters</h4><p>in EPTF_LGenBase_ReportedEventDescriptor pl_event in EPTF_IntegerList pl_listenerArgs</p><h4 class=CHeading>Return Value</h4><p>-</p><h4 class=CHeading>Errors</h4><p>-</p><h4 class=CHeading>Detailed Comments</h4><p>-</p></div></div></div> |
| |
| <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="f_EPTF_MBT_Listener_catchGenericEvents"></a>f_EPTF_MBT_Listener_catchGenericEvents</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "colspan=3>function f_EPTF_MBT_Listener_catchGenericEvents(</td></tr><tr><td> </td><td class="PType prettyprint " nowrap>EPTF_LGenBase_ReportedEventDescriptor </td><td class="PParameter prettyprint " nowrap width=100%>pl_event,</td></tr><tr><td> </td><td class="PType prettyprint " nowrap>EPTF_IntegerList </td><td class="PParameter prettyprint " nowrap width=100%>pl_listenerArgs</td></tr><tr><td class="PAfterParameters prettyprint "colspan=3>) runs on EPTF_MBT_LGen_CT</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>This is a listener to catch all generic level events. Because unhandled events in the FSM descriptor can catch only FSM level events.</p><h4 class=CHeading>Parameters</h4><p>in EPTF_LGenBase_ReportedEventDescriptor pl_event in EPTF_IntegerList pl_listenerArgs</p><h4 class=CHeading>Return Value</h4><p>-</p><h4 class=CHeading>Errors</h4><p>-</p><h4 class=CHeading>Detailed Comments</h4><p>-</p></div></div></div> |
| |
| <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="as_EPTF_MBT_PCO_Handler"></a>as_EPTF_MBT_PCO_Handler</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">altstep as_EPTF_MBT_PCO_Handler() runs on EPTF_MBT_LGen_CT</td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>EventHandler of the MBT AppLib</p><h4 class=CHeading>Parameters</h4><p>-</p><h4 class=CHeading>Return Value</h4><p>-</p><h4 class=CHeading>Errors</h4><p>-</p><h4 class=CHeading>Detailed Comments</h4><p>Handles the following cases In case of an incomming TestStep Request dispatches the c_EPTF_MBT_inputIdx_incomingTestStepRequest event incomming Config Request configure the LoadGens creates the entity goups activate the fsms...etc incomming Command Request executes the requested command - incomming User Request dispatches the c_EPTF_MBT_inputIdx_incomingUserRequest event</p></div></div></div> |
| |
| <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="f_EPTF_MBT_initLGenFsm"></a>f_EPTF_MBT_initLGenFsm</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "colspan=4>function f_EPTF_MBT_initLGenFsm (</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>fcb_EPTF_MBT_customUserFunction </td><td class="PParameter prettyprint " nowrap width=100%>p_userFunc,</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>fcb_EPTF_MBT_entityGroupCreated </td><td class="PParameter prettyprint " nowrap width=100%>p_entityGroupCreateFunc</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MBT_LGen_CT</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>This function inits the MBT FSM</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>in fcb_EPTF_MBT_customUserFunction p_userFunc</td><td class=CDLDescription>sets the callback that shall create the UserResponses</td></tr><tr><td class=CDLEntry>in fcb_EPTF_MBT_entityGroupCreated p_entityGroupCreateFunc</td><td class=CDLDescription>sets the callback to handle entity group created</td></tr></table><h4 class=CHeading>Return Value</h4><p>-</p><h4 class=CHeading>Errors</h4><p>-</p><h4 class=CHeading>Detailed Comments</h4><p>-</p></div></div></div> |
| |
| <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="f_EPTF_MBT_Tester_init"></a>f_EPTF_MBT_Tester_init</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "colspan=4>function f_EPTF_MBT_Tester_init (</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>charstring </td><td class="PParameter prettyprint " nowrap width=100%>pl_selfName</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MBT_Tester_CT</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>This function inits the EPTF_MBT_Tester_CT</p><h4 class=CHeading>Parameters</h4><ul><li><b>in</b> <b>charstring</b> pl_selfName - local internal name for the MBT Tester component</li></ul><h4 class=CHeading>Return Value</h4><p>-</p><h4 class=CHeading>Errors</h4><p>-</p><h4 class=CHeading>Detailed Comments</h4><p>-</p></div></div></div> |
| |
| <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="f_MBT_execute"></a>f_MBT_execute</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "colspan=6>function f_MBT_execute(</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>charstring </td><td class="PParameter prettyprint " nowrap>p_name,</td><td class="PDefaultValuePrefix prettyprint "> </td><td class="PDefaultValue prettyprint " width=100%></td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in EPTF_MBT_LGen_Definitions.</td><td class="PType prettyprint " nowrap>FsmAddr </td><td class="PParameter prettyprint " nowrap>p_addr,</td><td class="PDefaultValuePrefix prettyprint "> </td><td class="PDefaultValue prettyprint " width=100%></td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in EPTF_IntegerList </td><td class="PType prettyprint " nowrap>p_params </td><td class="PParameter prettyprint " nowrap>:</td><td class="PDefaultValuePrefix prettyprint "> = </td><td class="PDefaultValue prettyprint " width=100%> {},</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in boolean </td><td class="PType prettyprint " nowrap>p_lock </td><td class="PParameter prettyprint " nowrap>:</td><td class="PDefaultValuePrefix prettyprint "> = </td><td class="PDefaultValue prettyprint " width=100%> true</td></tr><tr><td class="PAfterParameters prettyprint "colspan=6>) runs on EPTF_MBT_Tester_CT</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>This function executes a test step on specifid FSM (which must run the FSM_MBT) FSM. It is possible to make the function blocking until the test stepis executed by setting the p_lock parameter to true, but it will only work in case the component extends the EPTF_MBT_Tester_CT and EPTF_MBT_LGen_CT as well!</p><h4 class=CHeading>Parameters</h4><ul><li><b>in</b> <b>charstring</b> p_name - name of the test step</li><li><b>in</b> <a href="EPTF_MBT_LGen_Definitions-ttcn.html#FsmAddr" class=LType id=link22 onMouseOver="ShowTip(event, 'tt22', 'link22')" onMouseOut="HideTip('tt22')">FsmAddr</a> p_addr - address of the FSM</li><li><b>in</b> <EPTF_IntegerList> - p_params - parameters for the test step</li><li><b>in</b> <b>boolean</b> - p_lock - Enables/disables waiting for the test step to finish executing.</li></ul><h4 class=CHeading>Return Value</h4><p>-</p><h4 class=CHeading>Errors</h4><p>-</p><h4 class=CHeading>Detailed Comments</h4><p>-</p></div></div></div> |
| |
| <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="f_MBT_waitFor"></a>f_MBT_waitFor</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "colspan=6>function f_MBT_waitFor(</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>charstring </td><td class="PParameter prettyprint " nowrap>p_behavior,</td><td class="PDefaultValuePrefix prettyprint "> </td><td class="PDefaultValue prettyprint " width=100%></td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in template </td><td class="PType prettyprint " nowrap>charstring </td><td class="PParameter prettyprint " nowrap>p_name,</td><td class="PDefaultValuePrefix prettyprint "> </td><td class="PDefaultValue prettyprint " width=100%></td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in template EPTF_MBT_LGen_Definitions.</td><td class="PType prettyprint " nowrap>FsmAddr </td><td class="PParameter prettyprint " nowrap>p_addr,</td><td class="PDefaultValuePrefix prettyprint "> </td><td class="PDefaultValue prettyprint " width=100%></td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in float </td><td class="PType prettyprint " nowrap>p_timeout </td><td class="PParameter prettyprint " nowrap>:</td><td class="PDefaultValuePrefix prettyprint "> = </td><td class="PDefaultValue prettyprint " width=100%> 30.0</td></tr><tr><td class="PAfterParameters prettyprint "colspan=6>) runs on EPTF_MBT_Tester_CT return boolean</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>This function waits for specified EPTF event to arrive. Please note, that until the waiting time runs out all the other incoming events are dropped.</p><h4 class=CHeading>Parameters</h4><ul><li><b>in</b> <b>charstring</b> p_behavior - behavior name of the expected event</li><li><b>in</b> <b>charstring</b> p_name - name of the expected event</li><li><b>in</b> <a href="EPTF_MBT_LGen_Definitions-ttcn.html#FsmAddr" class=LType id=link23 onMouseOver="ShowTip(event, 'tt22', 'link23')" onMouseOut="HideTip('tt22')">FsmAddr</a> - p_addr - the event must arrive from this FSM.</li><li><b>in</b> <b>float</b> - p_timeout - Maximum waiting time for the expected event</li></ul><h4 class=CHeading>Return Value</h4><ul><li><b>boolean</b> - True if the expected emssage was caught.</li></ul><h4 class=CHeading>Errors</h4><p>-</p><h4 class=CHeading>Detailed Comments</h4><p>-</p></div></div></div> |
| |
| <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="f_MBT_dispatch"></a>f_MBT_dispatch</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "colspan=4>function f_MBT_dispatch(</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>charstring </td><td class="PParameter prettyprint " nowrap width=100%>p_bName,</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>integer </td><td class="PParameter prettyprint " nowrap width=100%>p_iIndex,</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in EPTF_MBT_LGen_Definitions.</td><td class="PType prettyprint " nowrap>FsmAddr </td><td class="PParameter prettyprint " nowrap width=100%>p_addr</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MBT_Tester_CT</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>This function sends an EPTF event to an FSM.</p><h4 class=CHeading>Parameters</h4><ul><li><b>in</b> <b>charstring</b> p_bName - behavior name of the event</li><li><b>in</b> <b>integer</b> p_iIndex - index of the event</li><li><b>in</b> <a href="EPTF_MBT_LGen_Definitions-ttcn.html#FsmAddr" class=LType id=link24 onMouseOver="ShowTip(event, 'tt22', 'link24')" onMouseOut="HideTip('tt22')">FsmAddr</a> - p_addr - the event will be sent to this FSM.</li></ul><h4 class=CHeading>Return Value</h4><p>-</p><h4 class=CHeading>Errors</h4><p>-</p><h4 class=CHeading>Detailed Comments</h4><p>-</p></div></div></div> |
| |
| <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="f_MBT_activateFsm"></a>f_MBT_activateFsm</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "colspan=4>function f_MBT_activateFsm(</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>charstring </td><td class="PParameter prettyprint " nowrap width=100%>p_entityGroupName,</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>integer </td><td class="PParameter prettyprint " nowrap width=100%>p_eIdx,</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>charstring </td><td class="PParameter prettyprint " nowrap width=100%>p_fsmName,</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>out </td><td class="PType prettyprint " nowrap>FsmAddr </td><td class="PParameter prettyprint " nowrap width=100%>p_fsmAddr</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MBT_Tester_CT return integer</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>This function activates an FSM on an entity.</p><h4 class=CHeading>Parameters</h4><ul><li><b>in</b> <b>charstring</b> p_entityGroupName - entity group name of the entity</li><li><b>in</b> <b>integer</b> p_eIdx - index of the entity</li><li><b>in</b> <b>charstring</b> - p_fsmName - the event will be sent to this FSM.</li><li><b>out</b> <b>FsmAddr</b> - p_fsmAddr - The address of the activated FSM if succesful</li></ul><h4 class=CHeading>Return Value</h4><ul><li><b>integer</b> - the result of the FSM activation (-1 if unsuccesful)</li></ul><h4 class=CHeading>Errors</h4><p>-</p><h4 class=CHeading>Detailed Comments</h4><p>-</p></div></div></div> |
| |
| <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="f_convert_FsmAddr2TestStepArgs"></a>f_convert_FsmAddr2TestStepArgs</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "colspan=4>function f_convert_FsmAddr2TestStepArgs(</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in EPTF_MBT_LGen_Definitions.</td><td class="PType prettyprint " nowrap>FsmAddr </td><td class="PParameter prettyprint " nowrap width=100%>p_addr</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) return EPTF_LGenBase_TestStepArgs</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>Utility function to convert an FsmAddr address to a TestStepArgs value.</p><h4 class=CHeading>Parameters</h4><ul><li><b>in</b> <b>FsmAddr</b> - p_fsmAddr - An FSM address</li></ul><h4 class=CHeading>Return Value</h4><ul><li><EPTF_LGenBase_TestStepArgs> - the corresponding TestStapArgs value</li></ul><h4 class=CHeading>Errors</h4><p>-</p><h4 class=CHeading>Detailed Comments</h4><p>-</p></div></div></div> |
| |
| </div><!--Content--> |
| |
| |
| |
| <!--START_ND_TOOLTIPS--> |
| <div class=CToolTip id="tt1"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "colspan=6>function f_EPTF_MBT_init (</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>charstring </td><td class="PParameter prettyprint " nowrap>pl_selfName,</td><td class="PDefaultValuePrefix prettyprint "> </td><td class="PDefaultValue prettyprint " width=100%></td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>integer </td><td class="PParameter prettyprint " nowrap>pl_selfId,</td><td class="PDefaultValuePrefix prettyprint "> </td><td class="PDefaultValue prettyprint " width=100%></td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>charstring </td><td class="PParameter prettyprint " nowrap>pl_entityNamePrefix,</td><td class="PDefaultValuePrefix prettyprint "> </td><td class="PDefaultValue prettyprint " width=100%></td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in integer </td><td class="PType prettyprint " nowrap>pl_numEntities </td><td class="PParameter prettyprint " nowrap>:</td><td class="PDefaultValuePrefix prettyprint "> = </td><td class="PDefaultValue prettyprint " width=100%> 0,</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in EPTF_LGenBase_BehaviorContextBinder_FT </td><td class="PType prettyprint " nowrap>pl_bind </td><td class="PParameter prettyprint " nowrap>:</td><td class="PDefaultValuePrefix prettyprint "> = </td><td class="PDefaultValue prettyprint " width=100%> refers(f_EPTF_MBT_bindEntity),</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in EPTF_LGenBase_BehaviorContextHandler_FT </td><td class="PType prettyprint " nowrap>pl_reset </td><td class="PParameter prettyprint " nowrap>:</td><td class="PDefaultValuePrefix prettyprint "> = </td><td class="PDefaultValue prettyprint " width=100%> refers(f_EPTF_MBT_resetEntity),</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in EPTF_LGenBase_BehaviorContextHandler_FT </td><td class="PType prettyprint " nowrap>pl_unbind </td><td class="PParameter prettyprint " nowrap>:</td><td class="PDefaultValuePrefix prettyprint "> = </td><td class="PDefaultValue prettyprint " width=100%> refers(f_EPTF_MBT_unbindEntity)</td></tr><tr><td class="PAfterParameters prettyprint "colspan=6>) runs on EPTF_MBT_LGen_CT</td></tr></table></td></tr></table></blockquote>Function to initialize MBT behaviour</div></div><div class=CToolTip id="tt2"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">function f_EPTF_MBT_cleanup_CT() runs on EPTF_MBT_LGen_CT</td></tr></table></blockquote>Cleanup function of the MBT Applib</div></div><div class=CToolTip id="tt3"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">function f_EPTF_MBT_declareEvents() runs on EPTF_MBT_LGen_CT</td></tr></table></blockquote>Register the EVents used by the MBT AppLib</div></div><div class=CToolTip id="tt4"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">function f_EPTF_MBT_declareTestSteps() runs on EPTF_MBT_LGen_CT</td></tr></table></blockquote>Register the TestSteps used by the MBT AppLib</div></div><div class=CToolTip id="tt5"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "colspan=4>function f_EPTF_MBT_bindEntity(</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>integer </td><td class="PParameter prettyprint " nowrap width=100%>pl_eIdx</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MBT_LGen_CT return EPTF_IntegerList</td></tr></table></td></tr></table></blockquote>Bind function of the MBT AppLib</div></div><div class=CToolTip id="tt6"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>function f_EPTF_MBT_unbindEntity(</td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>integer </td><td class="PParameter prettyprint " nowrap>pl_eIdx</td><td class="PAfterParameters prettyprint "nowrap>) runs on EPTF_MBT_LGen_CT</td></tr></table></td></tr></table></blockquote>Unbind function of the MBT AppLib</div></div><div class=CToolTip id="tt7"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>function f_EPTF_MBT_resetEntity(</td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>integer </td><td class="PParameter prettyprint " nowrap>pl_eIdx</td><td class="PAfterParameters prettyprint "nowrap>) runs on EPTF_MBT_LGen_CT</td></tr></table></td></tr></table></blockquote>Reset function of the MBT AppLib</div></div><div class=CToolTip id="tt8"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "colspan=4>function f_EPTF_MBT_TestStep_invokeTestStep(</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>EPTF_LGenBase_TestStepArgs </td><td class="PParameter prettyprint " nowrap width=100%>pl_ptr</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MBT_LGen_CT</td></tr></table></td></tr></table></blockquote>General Purpose wrapper TestStep to select the Proper TestStep based on its actual parameters and invokes it. </div></div><div class=CToolTip id="tt9"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "colspan=4>function f_EPTF_MBT_TestStep_sendUserResponse(</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>EPTF_LGenBase_TestStepArgs </td><td class="PParameter prettyprint " nowrap width=100%>pl_ptr</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MBT_LGen_CT</td></tr></table></td></tr></table></blockquote>TestStep function to generate the User response,. </div></div><div class=CToolTip id="tt10"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "colspan=4>function f_EPTF_MBT_TestStep_invokeUserFunction(</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>EPTF_LGenBase_TestStepArgs </td><td class="PParameter prettyprint " nowrap width=100%>pl_ptr</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MBT_LGen_CT</td></tr></table></td></tr></table></blockquote>TestStep function to invoke user specific function</div></div><div class=CToolTip id="tt11"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "colspan=3>function f_EPTF_MBT_Listener_catchEntityEvents(</td></tr><tr><td> </td><td class="PType prettyprint " nowrap>EPTF_LGenBase_ReportedEventDescriptor </td><td class="PParameter prettyprint " nowrap width=100%>pl_event,</td></tr><tr><td> </td><td class="PType prettyprint " nowrap>EPTF_IntegerList </td><td class="PParameter prettyprint " nowrap width=100%>pl_listenerArgs</td></tr><tr><td class="PAfterParameters prettyprint "colspan=3>) runs on EPTF_MBT_LGen_CT</td></tr></table></td></tr></table></blockquote>This is a listener to catch all entity level events. </div></div><div class=CToolTip id="tt12"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "colspan=3>function f_EPTF_MBT_Listener_catchGenericEvents(</td></tr><tr><td> </td><td class="PType prettyprint " nowrap>EPTF_LGenBase_ReportedEventDescriptor </td><td class="PParameter prettyprint " nowrap width=100%>pl_event,</td></tr><tr><td> </td><td class="PType prettyprint " nowrap>EPTF_IntegerList </td><td class="PParameter prettyprint " nowrap width=100%>pl_listenerArgs</td></tr><tr><td class="PAfterParameters prettyprint "colspan=3>) runs on EPTF_MBT_LGen_CT</td></tr></table></td></tr></table></blockquote>This is a listener to catch all generic level events. </div></div><div class=CToolTip id="tt13"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">altstep as_EPTF_MBT_PCO_Handler() runs on EPTF_MBT_LGen_CT</td></tr></table></blockquote>EventHandler of the MBT AppLib</div></div><div class=CToolTip id="tt14"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "colspan=4>function f_EPTF_MBT_initLGenFsm (</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>fcb_EPTF_MBT_customUserFunction </td><td class="PParameter prettyprint " nowrap width=100%>p_userFunc,</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>fcb_EPTF_MBT_entityGroupCreated </td><td class="PParameter prettyprint " nowrap width=100%>p_entityGroupCreateFunc</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MBT_LGen_CT</td></tr></table></td></tr></table></blockquote>This function inits the MBT FSM</div></div><div class=CToolTip id="tt15"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "colspan=4>function f_EPTF_MBT_Tester_init (</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>charstring </td><td class="PParameter prettyprint " nowrap width=100%>pl_selfName</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MBT_Tester_CT</td></tr></table></td></tr></table></blockquote>This function inits the EPTF_MBT_Tester_CT</div></div><div class=CToolTip id="tt16"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "colspan=6>function f_MBT_execute(</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>charstring </td><td class="PParameter prettyprint " nowrap>p_name,</td><td class="PDefaultValuePrefix prettyprint "> </td><td class="PDefaultValue prettyprint " width=100%></td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in EPTF_MBT_LGen_Definitions.</td><td class="PType prettyprint " nowrap>FsmAddr </td><td class="PParameter prettyprint " nowrap>p_addr,</td><td class="PDefaultValuePrefix prettyprint "> </td><td class="PDefaultValue prettyprint " width=100%></td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in EPTF_IntegerList </td><td class="PType prettyprint " nowrap>p_params </td><td class="PParameter prettyprint " nowrap>:</td><td class="PDefaultValuePrefix prettyprint "> = </td><td class="PDefaultValue prettyprint " width=100%> {},</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in boolean </td><td class="PType prettyprint " nowrap>p_lock </td><td class="PParameter prettyprint " nowrap>:</td><td class="PDefaultValuePrefix prettyprint "> = </td><td class="PDefaultValue prettyprint " width=100%> true</td></tr><tr><td class="PAfterParameters prettyprint "colspan=6>) runs on EPTF_MBT_Tester_CT</td></tr></table></td></tr></table></blockquote>This function executes a test step on specifid FSM (which must run the FSM_MBT) FSM. </div></div><div class=CToolTip id="tt17"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "colspan=6>function f_MBT_waitFor(</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>charstring </td><td class="PParameter prettyprint " nowrap>p_behavior,</td><td class="PDefaultValuePrefix prettyprint "> </td><td class="PDefaultValue prettyprint " width=100%></td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in template </td><td class="PType prettyprint " nowrap>charstring </td><td class="PParameter prettyprint " nowrap>p_name,</td><td class="PDefaultValuePrefix prettyprint "> </td><td class="PDefaultValue prettyprint " width=100%></td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in template EPTF_MBT_LGen_Definitions.</td><td class="PType prettyprint " nowrap>FsmAddr </td><td class="PParameter prettyprint " nowrap>p_addr,</td><td class="PDefaultValuePrefix prettyprint "> </td><td class="PDefaultValue prettyprint " width=100%></td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in float </td><td class="PType prettyprint " nowrap>p_timeout </td><td class="PParameter prettyprint " nowrap>:</td><td class="PDefaultValuePrefix prettyprint "> = </td><td class="PDefaultValue prettyprint " width=100%> 30.0</td></tr><tr><td class="PAfterParameters prettyprint "colspan=6>) runs on EPTF_MBT_Tester_CT return boolean</td></tr></table></td></tr></table></blockquote>This function waits for specified EPTF event to arrive. </div></div><div class=CToolTip id="tt18"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "colspan=4>function f_MBT_dispatch(</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>charstring </td><td class="PParameter prettyprint " nowrap width=100%>p_bName,</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>integer </td><td class="PParameter prettyprint " nowrap width=100%>p_iIndex,</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in EPTF_MBT_LGen_Definitions.</td><td class="PType prettyprint " nowrap>FsmAddr </td><td class="PParameter prettyprint " nowrap width=100%>p_addr</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MBT_Tester_CT</td></tr></table></td></tr></table></blockquote>This function sends an EPTF event to an FSM.</div></div><div class=CToolTip id="tt19"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "colspan=4>function f_MBT_activateFsm(</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>charstring </td><td class="PParameter prettyprint " nowrap width=100%>p_entityGroupName,</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>integer </td><td class="PParameter prettyprint " nowrap width=100%>p_eIdx,</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>charstring </td><td class="PParameter prettyprint " nowrap width=100%>p_fsmName,</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>out </td><td class="PType prettyprint " nowrap>FsmAddr </td><td class="PParameter prettyprint " nowrap width=100%>p_fsmAddr</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MBT_Tester_CT return integer</td></tr></table></td></tr></table></blockquote>This function activates an FSM on an entity.</div></div><div class=CToolTip id="tt20"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "colspan=4>function f_convert_FsmAddr2TestStepArgs(</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in EPTF_MBT_LGen_Definitions.</td><td class="PType prettyprint " nowrap>FsmAddr </td><td class="PParameter prettyprint " nowrap width=100%>p_addr</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) return EPTF_LGenBase_TestStepArgs</td></tr></table></td></tr></table></blockquote>Utility function to convert an FsmAddr address to a TestStepArgs value.</div></div><div class=CToolTip id="tt21"><div class=CFile>Type definitions for the MBT Applib</div></div><div class=CToolTip id="tt22"><div class=CType><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">type record FsmAddr</td></tr></table></blockquote>Describes the FSM address</div></div><!--END_ND_TOOLTIPS--> |
| |
| <script language=JavaScript><!-- |
| if (browserType) {if (browserVer) {document.write("</div>"); }document.write("</div>");}// --></script></body></html> |
