MARTe2 » MARTe2-core

Implement requirement MARTe-EX-F-1.2.11 based on the original MARTe implementation

Note: While waiting for a given event or resource to be available a framework developer might decide to wait and return the control to the operating system schedule.

h1. Source code files modified

* Source\Core\L0Portability\Architecture\x86_cl\HighResolutionTimerA.h
* Source\Core\L0Portability\Architecture\x86_gcc\HighResolutionTimerA.h
* Source\Core\L0Portability\HighResolutionTimer.cpp
* Source\Core\L0Portability\HighResolutionTimer.h
* Source\Core\L0Portability\OperatingSystem\Linux\HighResolutionTimerCalibratorOS.h
* Source\Core\L0Portability\OperatingSystem\Linux\SleepOS.h
* Source\Core\L0Portability\OperatingSystem\Windows\HighResolutionTimerCalibratorOS.h
* Source\Core\L0Portability\OperatingSystem\Windows\SleepOS.h
* Source\Core\L0Portability\Sleep.cpp
* Source\Core\L0Portability\Sleep.h

h1. Architecture & design review

*Date of the review:* 08/06/2015

*Person who did the review:* André Neto

*Version of architecture & design document:* N/A. As per the original MARTe implementation, this is implemented in a support class and does not require formal design in UML.

*Result of review:* N/A

*List of non-conformities:* N/A

h1. Code and documentation review

*Date of the review:* 17/06/2015

*Person who did the review:* Ivan Herrero

*Result of review:* FAIL

*List of non-conformities:*

Manual review for Source\Core\L0Portability\Architecture\x86_cl\HighResolutionTimerA.h
This file has not been reviewed, because it is pending further discussion.

Manual review for Source\Core\L0Portability\Architecture\x86_gcc\HighResolutionTimerA.h
This file has not been reviewed, because it is pending further discussion.

Manual review for Source\Core\L0Portability\HighResolutionTimer.cpp
The @brief tag on file documentation says "Header file" instead of "Source file" (fix it copying the final text from last marte_cpp_code_templates.xml version).
The @details tag on file documentation says "header" and "declaration" instead of "source" and "definition" (fix it copying the final text from last marte_cpp_code_templates.xml version).
Definition of methods have comments which seem to overlap with those on declaration counterparts.

Manual review for Source\Core\L0Portability\HighResolutionTimer.h
The openning and closing symbols for comments ("/**" and "*/") do not have their own line.

Manual review for Source\Core\L0Portability\OperatingSystem\Linux\HighResolutionTimerCalibratorOS.h
This file has not been reviewed, because it is pending further discussion.

Manual review for Source\Core\L0Portability\OperatingSystem\Linux\SleepOS.h
Violation of rule 16–2–2 (macro LINUX_SLEEP_NO_MORE_MIN_USEC_TIME).

Manual review for Source\Core\L0Portability\OperatingSystem\Windows\HighResolutionTimerCalibratorOS.h
This file has not been reviewed, because it is pending further discussion.

Manual review for Source\Core\L0Portability\OperatingSystem\Windows\SleepOS.h
Violation of rule 16–2–2 (macro WIN_SLEEP_FREQ).

Manual review for Source\Core\L0Portability\Sleep.cpp
The @brief tag on file documentation says "Header file" instead of "Source file" (fix it copying the final text from last marte_cpp_code_templates.xml version).
The @details tag on file documentation says "header" and "declaration" instead of "source" and "definition" (fix it copying the final text from last marte_cpp_code_templates.xml version).

Manual review for Source\Core\L0Portability\Sleep.h
It lacks the Sleep class declaration (all the functions are currently standalone).

*Note:* Automatic review with cppcheck OK