phosphor-power-sequencer/src/config_file_parser.hpp

20 #include <nlohmann/json.hpp>
33  * Standard JSON configuration file directory on the BMC.
38  * Finds the JSON configuration file for the current system based on the
55  * @return path to the JSON configuration file, or an empty path if none was
63  * Parses the specified JSON configuration file.
81  * Returns the specified property of the specified JSON element.
85  * @param element JSON element
92 inline const nlohmann::json& getRequiredProperty(const nlohmann::json& element,  in getRequiredProperty()
105  * Parses a JSON element containing a boolean.
111  * @param element JSON element
114 inline bool parseBoolean(const nlohmann::json& element)  in parseBoolean()
125  * Parses a JSON element containing a GPIO.
131  * @param element JSON element
134 GPIO parseGPIO(const nlohmann::json& element);
137  * Parses a JSON element containing a rail.
143  * @param element JSON element
146 std::unique_ptr<Rail> parseRail(const nlohmann::json& element);
149  * Parses a JSON element containing an array of rails.
155  * @param element JSON element
159     parseRailArray(const nlohmann::json& element);
162  * Parses the JSON root element of the entire configuration file.
168  * @param element JSON element
171 std::vector<std::unique_ptr<Rail>> parseRoot(const nlohmann::json& element);
174  * Parses a JSON element containing a string.
180  * @param element JSON element
184 inline std::string parseString(const nlohmann::json& element,  in parseString()
200  * Parses a JSON element containing an 8-bit unsigned integer.
206  * @param element JSON element
209 inline uint8_t parseUint8(const nlohmann::json& element)  in parseUint8()
225  * Parses a JSON element containing an unsigned integer.
231  * @param element JSON element
234 inline unsigned int parseUnsignedInteger(const nlohmann::json& element)  in parseUnsignedInteger()
245  * Verifies that the specified JSON element is a JSON array.
249  * @param element JSON element
251 inline void verifyIsArray(const nlohmann::json& element)  in verifyIsArray()
260  * Verifies that the specified JSON element is a JSON object.
264  * @param element JSON element
266 inline void verifyIsObject(const nlohmann::json& element)  in verifyIsObject()
275  * Verifies that the specified JSON element contains the expected number of
282  * @param element JSON element
285 inline void verifyPropertyCount(const nlohmann::json& element,  in verifyPropertyCount()