SNIP_CLASSIC_ETHIF_SECTION_8_3_14_EthIf_GetAndResetMeasurementData

8.3.14 EthIf_GetAndResetMeasurementData [SWS_EthIf_91011] Definition of API function EthIf_GetAndResetMeasurement Data ⌈ Service Name EthIf_GetAndResetMeasurementData Syntax Std_ReturnType EthIf_GetAndResetMeasurementData ( EthIf_MeasurementIdxType MeasurementIdx, boolean MeasurementResetNeeded, uint32* MeasurementDataPtr ) Service ID [hex] 0x45 Sync/Async Synchronous Reentrancy Reentrant MeasurementIdx Data index of measurement data Parameters (in) MeasurementReset Needed Flag to trigger a reset of the measurement data Parameters (inout) None Parameters (out) MeasurementDataPtr Reference to data buffer, where to copy measurement data Return value Std_ReturnType E_OK: successful E_NOT_OK: failed Description Allows to read and reset detailed measurement data for diagnostic purposes. Get all MeasurementIdx’s at once is not supported. ETHIF_MEAS_ALL shall only be used to reset all MeasurementIdx’s at once. A NULL_PTR shall be provided for MeasurementDataPtr in this case. Available via EthIf.h ⌋() [SWS_EthIf_00308] ⌈EthIf_GetAndResetMeasurementData shall return measurement data for selected measurement index.⌋() [SWS_EthIf_00309] ⌈For measurement index ETHIF_MEAS_DROP_CRTLIDX the function shall return the number of all dropped datagrams, caused by invalid CrtlIdx/VLAN. If the VLAN is not enabled, all received VLAN tagged datagrams are invalid and shall be counted also.⌋() [SWS_EthIf_00310] ⌈The function shall return E_NOT_OK if the requested measurement index is not supported.⌋() [SWS_EthIf_00312] ⌈The function shall reset all existing measurement data to 0, if MeasurementResetNeeded is true and measurement index is set to ETHIF_MEAS_ALL.⌋() [SWS_EthIf_00313] ⌈All measurement data which counts data shall not overrun.⌋() [SWS_EthIf_00314] ⌈The function shall accept NULL_PTR. In this case the measurement data shall not be copied.⌋() [SWS_EthIf_00316] ⌈The function shall be pre compile time configurable On/Off by the configuration parameter: EthIfGetAndResetMeasurementDataApi.⌋() [SWS_EthIf_00317] ⌈If the VLAN is not active the Ethernet Interface shall increment the corresponding measurement data and filter the message.⌋() [SWS_EthIf_00319] ⌈If development error detection is enabled: The function shall check that the service EthIf_Init was previously called. If the check fails, the function shall raise the development error ETHIF_E_NOTINIT.⌋()