Zane Shelley | f685afd | 2021-02-15 15:39:44 -0600 | [diff] [blame] | 1 | #pragma once |
| 2 | |
Zane Shelley | c85716c | 2021-08-17 10:54:06 -0500 | [diff] [blame] | 3 | #include <analyzer/callout.hpp> |
Zane Shelley | 9513582 | 2021-08-23 09:00:05 -0500 | [diff] [blame^] | 4 | #include <analyzer/guard.hpp> |
Zane Shelley | 8af9e46 | 2021-03-11 10:44:28 -0600 | [diff] [blame] | 5 | #include <hei_main.hpp> |
Zane Shelley | f685afd | 2021-02-15 15:39:44 -0600 | [diff] [blame] | 6 | #include <nlohmann/json.hpp> |
| 7 | |
| 8 | namespace analyzer |
| 9 | { |
| 10 | |
Zane Shelley | 64791cf | 2021-02-15 17:02:37 -0600 | [diff] [blame] | 11 | /** |
| 12 | * @brief Data regarding required service actions based on the hardware error |
| 13 | * analysis. |
| 14 | */ |
| 15 | class ServiceData |
| 16 | { |
| 17 | public: |
Zane Shelley | 8af9e46 | 2021-03-11 10:44:28 -0600 | [diff] [blame] | 18 | /** |
| 19 | * @brief Constructor from components. |
| 20 | * @param The signature of the root cause attention. |
Zane Shelley | ca49619 | 2021-08-09 12:05:52 -0500 | [diff] [blame] | 21 | * @param True if the signature list contained a system checkstop attention. |
| 22 | * False, otherwise. |
Zane Shelley | 8af9e46 | 2021-03-11 10:44:28 -0600 | [diff] [blame] | 23 | */ |
Zane Shelley | ca49619 | 2021-08-09 12:05:52 -0500 | [diff] [blame] | 24 | ServiceData(const libhei::Signature& i_rootCause, bool i_isCheckstop) : |
| 25 | iv_rootCause(i_rootCause), iv_isCheckstop(i_isCheckstop) |
Zane Shelley | 8af9e46 | 2021-03-11 10:44:28 -0600 | [diff] [blame] | 26 | {} |
Zane Shelley | 64791cf | 2021-02-15 17:02:37 -0600 | [diff] [blame] | 27 | |
| 28 | /** @brief Destructor. */ |
| 29 | ~ServiceData() = default; |
| 30 | |
| 31 | /** @brief Copy constructor. */ |
| 32 | ServiceData(const ServiceData&) = default; |
| 33 | |
| 34 | /** @brief Assignment operator. */ |
| 35 | ServiceData& operator=(const ServiceData&) = default; |
| 36 | |
| 37 | private: |
Zane Shelley | 8af9e46 | 2021-03-11 10:44:28 -0600 | [diff] [blame] | 38 | /** The signature of the root cause attention. */ |
| 39 | const libhei::Signature iv_rootCause; |
| 40 | |
Zane Shelley | ca49619 | 2021-08-09 12:05:52 -0500 | [diff] [blame] | 41 | /** True if the signature list contained a system checkstop attention. |
| 42 | * False, otherwise. */ |
| 43 | const bool iv_isCheckstop; |
| 44 | |
Zane Shelley | 64791cf | 2021-02-15 17:02:37 -0600 | [diff] [blame] | 45 | /** The list of callouts that will be added to a PEL. */ |
Zane Shelley | c85716c | 2021-08-17 10:54:06 -0500 | [diff] [blame] | 46 | nlohmann::json iv_calloutList = nlohmann::json::array(); |
Zane Shelley | 64791cf | 2021-02-15 17:02:37 -0600 | [diff] [blame] | 47 | |
Zane Shelley | 5f6e3de | 2021-02-23 13:57:37 -0600 | [diff] [blame] | 48 | /** The list of hardware guard requests. Some information will be added to |
Zane Shelley | 9513582 | 2021-08-23 09:00:05 -0500 | [diff] [blame^] | 49 | * the PEL, but the actual guard record will be created after submitting |
| 50 | * the PEL. */ |
| 51 | std::vector<Guard> iv_guardList; |
Zane Shelley | 5f6e3de | 2021-02-23 13:57:37 -0600 | [diff] [blame] | 52 | |
Zane Shelley | 64791cf | 2021-02-15 17:02:37 -0600 | [diff] [blame] | 53 | public: |
Zane Shelley | 8af9e46 | 2021-03-11 10:44:28 -0600 | [diff] [blame] | 54 | /** @return The signature of the root cause attention. */ |
| 55 | const libhei::Signature& getRootCause() const |
| 56 | { |
| 57 | return iv_rootCause; |
| 58 | } |
| 59 | |
Zane Shelley | ca49619 | 2021-08-09 12:05:52 -0500 | [diff] [blame] | 60 | /** @return True if the signature list contained a system checkstop |
| 61 | * attention. False, otherwise. */ |
| 62 | bool queryCheckstop() const |
| 63 | { |
| 64 | return iv_isCheckstop; |
| 65 | } |
| 66 | |
Zane Shelley | c85716c | 2021-08-17 10:54:06 -0500 | [diff] [blame] | 67 | /** |
| 68 | * @brief Add callout information to the callout list. |
| 69 | * @param The JSON object for this callout. |
| 70 | */ |
| 71 | void addCallout(const nlohmann::json& i_callout) |
Zane Shelley | 64791cf | 2021-02-15 17:02:37 -0600 | [diff] [blame] | 72 | { |
| 73 | iv_calloutList.push_back(i_callout); |
| 74 | } |
| 75 | |
Zane Shelley | 9513582 | 2021-08-23 09:00:05 -0500 | [diff] [blame^] | 76 | /** |
| 77 | * @brief Add a guard request to the guard list. |
| 78 | * @param i_path Entity path for the target part. |
| 79 | * @param i_guard True, if the part should be guarded. False, otherwise. |
| 80 | */ |
| 81 | void addGuard(const std::string& i_path, bool i_guard) |
Zane Shelley | 5f6e3de | 2021-02-23 13:57:37 -0600 | [diff] [blame] | 82 | { |
Zane Shelley | 9513582 | 2021-08-23 09:00:05 -0500 | [diff] [blame^] | 83 | Guard::Type guardType = Guard::Type::NONE; |
| 84 | if (i_guard) |
| 85 | { |
| 86 | // The guard type is dependent on the presence of a system checkstop |
| 87 | // attention. |
| 88 | guardType = |
| 89 | queryCheckstop() ? Guard::Type::FATAL : Guard::Type::NON_FATAL; |
| 90 | } |
| 91 | |
| 92 | iv_guardList.emplace_back(i_path, guardType); |
Zane Shelley | 5f6e3de | 2021-02-23 13:57:37 -0600 | [diff] [blame] | 93 | } |
| 94 | |
Zane Shelley | c85716c | 2021-08-17 10:54:06 -0500 | [diff] [blame] | 95 | /** @brief Accessor to iv_calloutList. */ |
| 96 | const nlohmann::json& getCalloutList() const |
Zane Shelley | 64791cf | 2021-02-15 17:02:37 -0600 | [diff] [blame] | 97 | { |
Zane Shelley | c85716c | 2021-08-17 10:54:06 -0500 | [diff] [blame] | 98 | return iv_calloutList; |
Zane Shelley | 64791cf | 2021-02-15 17:02:37 -0600 | [diff] [blame] | 99 | } |
Zane Shelley | 5f6e3de | 2021-02-23 13:57:37 -0600 | [diff] [blame] | 100 | |
Zane Shelley | 9513582 | 2021-08-23 09:00:05 -0500 | [diff] [blame^] | 101 | /** @brief Accessor to iv_guardList. */ |
| 102 | const std::vector<Guard>& getGuardList() const |
Zane Shelley | 5f6e3de | 2021-02-23 13:57:37 -0600 | [diff] [blame] | 103 | { |
Zane Shelley | 9513582 | 2021-08-23 09:00:05 -0500 | [diff] [blame^] | 104 | return iv_guardList; |
Zane Shelley | 5f6e3de | 2021-02-23 13:57:37 -0600 | [diff] [blame] | 105 | } |
Zane Shelley | 64791cf | 2021-02-15 17:02:37 -0600 | [diff] [blame] | 106 | }; |
| 107 | |
Zane Shelley | f685afd | 2021-02-15 15:39:44 -0600 | [diff] [blame] | 108 | } // namespace analyzer |