From a0ba1ce80caf4d1f4eaca4786c6352d36d72a385 Mon Sep 17 00:00:00 2001 From: thodkatz <thodkatz@gmail.com> Date: Mon, 28 Jan 2019 17:16:14 +0200 Subject: [PATCH] Better names for some types --- inc/ErrorHandler.hpp | 14 +++++++------- inc/Services/RequestVerificationService.hpp | 6 +++--- src/ErrorHandler.cpp | 6 +++--- src/Services/RequestVerificationService.cpp | 6 +++--- src/main.cpp | 6 +++--- test/ErrorHandler.cpp | 12 ++++++------ test/Services/RequestVerificationService.cpp | 12 ++++++------ 7 files changed, 31 insertions(+), 31 deletions(-) diff --git a/inc/ErrorHandler.hpp b/inc/ErrorHandler.hpp index 2d829c4e..02625082 100644 --- a/inc/ErrorHandler.hpp +++ b/inc/ErrorHandler.hpp @@ -95,8 +95,8 @@ public: * Note: Numbers are kept in code explicitly, so that there is no uncertainty when something * changes. */ - enum StartExecutionErrorType { - UnknownStartExecutionError = 0, + enum ExecutionStartErrorType { + UnknownExecutionStartError = 0, }; /** @@ -105,8 +105,8 @@ public: * Note: Numbers are kept in code explicitly, so that there is no uncertainty when something * changes. */ - enum ProgressExecutionErrorType { - UnknownProgressExecutionError = 0, + enum ExecutionProgressErrorType { + UnknownExecutionProgressError = 0, }; /** @@ -127,8 +127,8 @@ public: * Note: Numbers are kept in code explicitly, so that there is no uncertainty when something * changes. */ - enum CompletionExecutionErrorType { - UnknownCompletionExecutionError = 0, + enum ExecutionCompletionErrorType { + UnknownExecutionCompletionError = 0, /** * Checksum comparison failed */ @@ -184,7 +184,7 @@ public: * occurs * @param step Step identifier */ - static void reportProgressError(const Message &message, ProgressExecutionErrorType errorCode, + static void reportProgressError(const Message &message, ExecutionProgressErrorType errorCode, stepID step); /** diff --git a/inc/Services/RequestVerificationService.hpp b/inc/Services/RequestVerificationService.hpp index 8b854dce..9f2b646e 100644 --- a/inc/Services/RequestVerificationService.hpp +++ b/inc/Services/RequestVerificationService.hpp @@ -60,7 +60,7 @@ public: * @param errorCode The cause of creating this type of report */ void failStartExecutionVerification(const Message &request, - ErrorHandler::StartExecutionErrorType + ErrorHandler::ExecutionStartErrorType errorCode); /** @@ -83,7 +83,7 @@ public: * @param step Step identifier */ void failProgressExecutionVerification(const Message &request, - ErrorHandler::ProgressExecutionErrorType errorCode, ErrorHandler::stepID step); + ErrorHandler::ExecutionProgressErrorType errorCode, ErrorHandler::stepID step); /** * TM[1,7] successful completion of execution verification report @@ -103,7 +103,7 @@ public: * @param errorCode The cause of creating this type of report */ void failCompletionExecutionVerification(const Message &request, - ErrorHandler::CompletionExecutionErrorType errorCode); + ErrorHandler::ExecutionCompletionErrorType errorCode); /** * TM[1,10] failed routing verification report diff --git a/src/ErrorHandler.cpp b/src/ErrorHandler.cpp index 0c9f69b2..2ba82fb3 100644 --- a/src/ErrorHandler.cpp +++ b/src/ErrorHandler.cpp @@ -15,13 +15,13 @@ void ErrorHandler::reportError(const Message &message, AcceptanceErrorType error } template<> -void ErrorHandler::reportError(const Message &message, StartExecutionErrorType errorCode) { +void ErrorHandler::reportError(const Message &message, ExecutionStartErrorType errorCode) { requestVerificationService.failStartExecutionVerification(message, errorCode); logError(message, errorCode); } -void ErrorHandler::reportProgressError(const Message &message, ProgressExecutionErrorType +void ErrorHandler::reportProgressError(const Message &message, ExecutionProgressErrorType errorCode, stepID step) { requestVerificationService.failProgressExecutionVerification(message, errorCode, step); @@ -29,7 +29,7 @@ errorCode, stepID step) { } template<> -void ErrorHandler::reportError(const Message &message, CompletionExecutionErrorType errorCode) { +void ErrorHandler::reportError(const Message &message, ExecutionCompletionErrorType errorCode) { requestVerificationService.failCompletionExecutionVerification(message, errorCode); logError(message, errorCode); diff --git a/src/Services/RequestVerificationService.cpp b/src/Services/RequestVerificationService.cpp index 6a76a194..6076cd28 100644 --- a/src/Services/RequestVerificationService.cpp +++ b/src/Services/RequestVerificationService.cpp @@ -50,7 +50,7 @@ void RequestVerificationService::successStartExecutionVerification(const Message } void RequestVerificationService::failStartExecutionVerification(const Message &request, - ErrorHandler::StartExecutionErrorType errorCode) { + ErrorHandler::ExecutionStartErrorType errorCode) { // TM[1,4] failed start of execution verification report Message report = createTM(4); @@ -84,7 +84,7 @@ void RequestVerificationService::successProgressExecutionVerification(const Mess } void RequestVerificationService::failProgressExecutionVerification(const Message &request, - ErrorHandler::ProgressExecutionErrorType errorCode, ErrorHandler::stepID step) { + ErrorHandler::ExecutionProgressErrorType errorCode, ErrorHandler::stepID step) { // TM[1,6] failed progress of execution verification report Message report = createTM(6); @@ -118,7 +118,7 @@ void RequestVerificationService::successCompletionExecutionVerification(const Me void RequestVerificationService::failCompletionExecutionVerification(const Message &request, - ErrorHandler::CompletionExecutionErrorType errorCode) { + ErrorHandler::ExecutionCompletionErrorType errorCode) { // TM[1,8] failed completion of execution verification report Message report = createTM(8); diff --git a/src/main.cpp b/src/main.cpp index 435d7d03..59e7f153 100644 --- a/src/main.cpp +++ b/src/main.cpp @@ -124,7 +124,7 @@ int main() { receivedMessage = Message(1, 4, Message::TC, 3); reqVerifService.failStartExecutionVerification(receivedMessage, - ErrorHandler::UnknownStartExecutionError); + ErrorHandler::UnknownExecutionStartError); receivedMessage = Message(1, 5, Message::TC, 3); reqVerifService.successProgressExecutionVerification(receivedMessage, @@ -132,14 +132,14 @@ int main() { receivedMessage = Message(1, 6, Message::TC, 3); reqVerifService.failProgressExecutionVerification(receivedMessage, - ErrorHandler::UnknownProgressExecutionError, ErrorHandler::UnknownStepID); + ErrorHandler::UnknownExecutionProgressError, ErrorHandler::UnknownStepID); receivedMessage = Message(1, 7, Message::TC, 3); reqVerifService.successCompletionExecutionVerification(receivedMessage); receivedMessage = Message(1, 8, Message::TC, 3); reqVerifService.failCompletionExecutionVerification(receivedMessage, - ErrorHandler::UnknownCompletionExecutionError); + ErrorHandler::UnknownExecutionCompletionError); receivedMessage = Message(1, 10, Message::TC, 3); reqVerifService.failRoutingVerification(receivedMessage, ErrorHandler::UnknownRoutingError); diff --git a/test/ErrorHandler.cpp b/test/ErrorHandler.cpp index 33ad7bd1..ee44e226 100644 --- a/test/ErrorHandler.cpp +++ b/test/ErrorHandler.cpp @@ -26,7 +26,7 @@ TEST_CASE("Error: Failed Acceptance", "[errors]") { TEST_CASE("Error: Failed Execution Start", "[errors]") { Message failedMessage(38, 32, Message::TC, 56); - ErrorHandler::reportError(failedMessage, ErrorHandler::UnknownStartExecutionError); + ErrorHandler::reportError(failedMessage, ErrorHandler::UnknownExecutionStartError); REQUIRE(ServiceTests::hasOneMessage()); Message report = ServiceTests::get(0); @@ -43,12 +43,12 @@ TEST_CASE("Error: Failed Execution Start", "[errors]") { CHECK(report.readBits(11) == 56); CHECK(report.readBits(2) == ECSS_SEQUENCE_FLAGS); CHECK(report.readBits(14) == failedMessage.packetSequenceCount); - CHECK(report.readEnum16() == ErrorHandler::UnknownStartExecutionError); + CHECK(report.readEnum16() == ErrorHandler::UnknownExecutionStartError); } TEST_CASE("Error: Failed Execution Progress", "[errors]") { Message failedMessage(38, 32, Message::TC, 56); - ErrorHandler::reportProgressError(failedMessage, ErrorHandler::UnknownProgressExecutionError, + ErrorHandler::reportProgressError(failedMessage, ErrorHandler::UnknownExecutionProgressError, ErrorHandler::UnknownStepID); REQUIRE(ServiceTests::hasOneMessage()); @@ -66,13 +66,13 @@ TEST_CASE("Error: Failed Execution Progress", "[errors]") { CHECK(report.readBits(11) == 56); CHECK(report.readBits(2) == ECSS_SEQUENCE_FLAGS); CHECK(report.readBits(14) == failedMessage.packetSequenceCount); - CHECK(report.readEnum16() == ErrorHandler::UnknownStartExecutionError); + CHECK(report.readEnum16() == ErrorHandler::UnknownExecutionProgressError); CHECK(report.readEnum16() == ErrorHandler::UnknownStepID); } TEST_CASE("Error: Failed Execution Completion", "[errors]") { Message failedMessage(38, 32, Message::TC, 56); - ErrorHandler::reportError(failedMessage, ErrorHandler::UnknownCompletionExecutionError); + ErrorHandler::reportError(failedMessage, ErrorHandler::UnknownExecutionCompletionError); REQUIRE(ServiceTests::hasOneMessage()); Message report = ServiceTests::get(0); @@ -89,7 +89,7 @@ TEST_CASE("Error: Failed Execution Completion", "[errors]") { CHECK(report.readBits(11) == 56); CHECK(report.readBits(2) == ECSS_SEQUENCE_FLAGS); CHECK(report.readBits(14) == failedMessage.packetSequenceCount); - CHECK(report.readEnum16() == ErrorHandler::UnknownCompletionExecutionError); + CHECK(report.readEnum16() == ErrorHandler::UnknownExecutionCompletionError); } TEST_CASE("Error: Failed Routing", "[errors]") { diff --git a/test/Services/RequestVerificationService.cpp b/test/Services/RequestVerificationService.cpp index a653c6d4..64c66def 100644 --- a/test/Services/RequestVerificationService.cpp +++ b/test/Services/RequestVerificationService.cpp @@ -79,7 +79,7 @@ TEST_CASE("TM[1,4]", "[service][st01]") { Message receivedMessage = Message(1, 2, Message::TC, 3); reqVerifService.failStartExecutionVerification(receivedMessage, - ErrorHandler::UnknownStartExecutionError); + ErrorHandler::UnknownExecutionStartError); REQUIRE(ServiceTests::hasOneMessage()); Message response = ServiceTests::get(0); @@ -96,7 +96,7 @@ TEST_CASE("TM[1,4]", "[service][st01]") { CHECK(response.readEnumerated(11) == 3); // application process ID CHECK(response.readEnumerated(2) == ECSS_SEQUENCE_FLAGS); // sequence flags CHECK(response.readBits(14) == 0); // packet sequence count - CHECK(response.readEnum16() == ErrorHandler::UnknownAcceptanceError); // error code + CHECK(response.readEnum16() == ErrorHandler::UnknownExecutionStartError); // error code } TEST_CASE("TM[1,5]", "[service][st01]") { @@ -129,7 +129,7 @@ TEST_CASE("TM[1,6]", "[service][st01]") { Message receivedMessage = Message(1, 5, Message::TC, 3); reqVerifService.failProgressExecutionVerification(receivedMessage, - ErrorHandler::UnknownProgressExecutionError, + ErrorHandler::UnknownExecutionProgressError, ErrorHandler::UnknownStepID); REQUIRE(ServiceTests::hasOneMessage()); @@ -148,7 +148,7 @@ TEST_CASE("TM[1,6]", "[service][st01]") { CHECK(response.readEnumerated(2) == ECSS_SEQUENCE_FLAGS); // sequence flags CHECK(response.readBits(14) == 0); // packet sequence count CHECK(response.readEnum16() == ErrorHandler::UnknownStepID); // step ID - CHECK(response.readEnum16() == ErrorHandler::UnknownProgressExecutionError); + CHECK(response.readEnum16() == ErrorHandler::UnknownExecutionProgressError); } TEST_CASE("TM[1,7]", "[service][st01]") { @@ -179,7 +179,7 @@ TEST_CASE("TM[1,8]", "[service][st01]") { Message receivedMessage = Message(1, 8, Message::TC, 3); reqVerifService.failCompletionExecutionVerification(receivedMessage, - ErrorHandler::UnknownCompletionExecutionError); + ErrorHandler::UnknownExecutionCompletionError); REQUIRE(ServiceTests::hasOneMessage()); Message response = ServiceTests::get(0); @@ -195,7 +195,7 @@ TEST_CASE("TM[1,8]", "[service][st01]") { CHECK(response.readEnumerated(11) == 3); // application process ID CHECK(response.readEnumerated(2) == ECSS_SEQUENCE_FLAGS); // sequence flags CHECK(response.readBits(14) == 0); // packet sequence count - CHECK(response.readEnum16() == ErrorHandler::UnknownCompletionExecutionError); // error code + CHECK(response.readEnum16() == ErrorHandler::UnknownExecutionCompletionError); // error code } TEST_CASE("TM[1,10]", "[service][st01]") { -- GitLab