Skip to content
Snippets Groups Projects
Commit 6280930f authored by thodkatz's avatar thodkatz
Browse files

Minor changes in the documentation

parent 18074a8d
No related branches found
No related tags found
No related merge requests found
......@@ -113,6 +113,7 @@ public:
* This enumeration type corresponds with reports about the progress of the execution
* of a request. For example if the execution of a request is a long process, then we can divide
* the process into steps and take feedback that depends on the step identifier
*
* @todo configure step ID for the suitable requests
*/
enum stepID {
......
......@@ -69,6 +69,7 @@ public:
* @param request Contains the necessary data to send the report.
* The data is actually some data members of Message that contain the basic info
* of the telecommand packet that its progress of execution is successful
* @param step Step identifier
*/
void successProgressExecutionVerification(const Message &request, ErrorHandler::stepID step);
......@@ -79,6 +80,7 @@ public:
* The data is actually some data members of Message that contain the basic info
* of the telecommand packet that its progress of execution has failed
* @param errorCode The cause of creating this type of report
* @param step Step identifier
*/
void failProgressExecutionVerification(const Message &request,
ErrorHandler::ProgressExecutionErrorType errorCode, ErrorHandler::stepID step);
......
......@@ -10,7 +10,7 @@ void RequestVerificationService::successAcceptanceVerification(const Message &re
report.appendEnumerated(1, request.packetType); // packet type
report.appendBits(1, 0); // secondary header flag(not implemented)
report.appendEnumerated(11, request.applicationId); // application process ID
report.appendEnumerated(2, ECSS_SEQUENCE_FLAGS); // sequence flags(not implemented)
report.appendEnumerated(2, ECSS_SEQUENCE_FLAGS); // sequence flags
report.appendBits(14, 0); // packet sequence count(not implemented)
storeMessage(report);
......@@ -27,7 +27,7 @@ RequestVerificationService::failAcceptanceVerification(const Message &request,
report.appendEnumerated(1, request.packetType); // packet type
report.appendBits(1, 0); // secondary header flag(not implemented)
report.appendEnumerated(11, request.applicationId); // application process ID
report.appendEnumerated(2, ECSS_SEQUENCE_FLAGS); // sequence flags(not implemented)
report.appendEnumerated(2, ECSS_SEQUENCE_FLAGS); // sequence flags
report.appendBits(14, 0); // packet sequence count(not implemented)
report.appendEnum16(errorCode); // error code
......@@ -43,7 +43,7 @@ void RequestVerificationService::successStartExecutionVerification(const Message
report.appendEnumerated(1, request.packetType); // packet type
report.appendBits(1, 0); // secondary header flag(not implemented)
report.appendEnumerated(11, request.applicationId); // application process ID
report.appendEnumerated(2, ECSS_SEQUENCE_FLAGS); // sequence flags(not implemented)
report.appendEnumerated(2, ECSS_SEQUENCE_FLAGS); // sequence flags
report.appendBits(14, 0); // packet sequence count
storeMessage(report);
......@@ -59,7 +59,7 @@ void RequestVerificationService::failStartExecutionVerification(const Message &r
report.appendEnumerated(1, request.packetType); // packet type
report.appendBits(1, 0); // secondary header flag(not implemented)
report.appendEnumerated(11, request.applicationId); // application process ID
report.appendEnumerated(2, ECSS_SEQUENCE_FLAGS); // sequence flags(not implemented)
report.appendEnumerated(2, ECSS_SEQUENCE_FLAGS); // sequence flags
report.appendBits(14, 0); // packet sequence count(not implemented)
report.appendEnum16(errorCode); // error code
......@@ -76,7 +76,7 @@ void RequestVerificationService::successProgressExecutionVerification(const Mess
report.appendEnumerated(1, request.packetType); // packet type
report.appendBits(1, 0); // secondary header flag(not implemented)
report.appendEnumerated(11, request.applicationId); // application process ID
report.appendEnumerated(2, ECSS_SEQUENCE_FLAGS); // sequence flags(not implemented)
report.appendEnumerated(2, ECSS_SEQUENCE_FLAGS); // sequence flags
report.appendBits(14, 0); // packet sequence count(not implemented)
report.appendEnum16(step); // step ID
......@@ -93,7 +93,7 @@ void RequestVerificationService::failProgressExecutionVerification(const Message
report.appendEnumerated(1, request.packetType); // packet type
report.appendBits(1, 0); // secondary header flag(not implemented)
report.appendEnumerated(11, request.applicationId); // application process ID
report.appendEnumerated(2, ECSS_SEQUENCE_FLAGS); // sequence flags(not implemented)
report.appendEnumerated(2, ECSS_SEQUENCE_FLAGS); // sequence flags
report.appendBits(14, 0); // packet sequence count(not implemented)
report.appendEnum16(step); // step ID
report.appendEnum16(errorCode); // error code
......@@ -110,7 +110,7 @@ void RequestVerificationService::successCompletionExecutionVerification(const Me
report.appendEnumerated(1, request.packetType); // packet type
report.appendBits(1, 0); // secondary header flag(not implemented)
report.appendEnumerated(11, request.applicationId); // application process ID
report.appendEnumerated(2, ECSS_SEQUENCE_FLAGS); // sequence flags(not implemented)
report.appendEnumerated(2, ECSS_SEQUENCE_FLAGS); // sequence flags
report.appendBits(14, 0); // packet sequence count(not implemented)
storeMessage(report);
......@@ -127,7 +127,7 @@ RequestVerificationService::failCompletionExecutionVerification(const Message &r
report.appendEnumerated(1, request.packetType); // packet type
report.appendBits(1, 0); // secondary header flag(not implemented)
report.appendEnumerated(11, request.applicationId); // application process ID
report.appendEnumerated(2, ECSS_SEQUENCE_FLAGS); // sequence flags(not implemented)
report.appendEnumerated(2, ECSS_SEQUENCE_FLAGS); // sequence flags
report.appendBits(14, 0); // packet sequence count(not implemented)
report.appendEnum16(errorCode); // error code
......@@ -145,7 +145,7 @@ RequestVerificationService::failRoutingVerification(const Message &request,
report.appendEnumerated(1, request.packetType); // packet type
report.appendBits(1, 0); // secondary header flag(not implemented)
report.appendEnumerated(11, request.applicationId); // application process ID
report.appendEnumerated(2, ECSS_SEQUENCE_FLAGS); // sequence flags(not implemented)
report.appendEnumerated(2, ECSS_SEQUENCE_FLAGS); // sequence flags
report.appendBits(14, 0); // packet sequence count(not implemented)
report.appendEnum16(errorCode); // error code
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment