openbmc/phosphor-power/json_parser_utils.hpp

18 #include <nlohmann/json.hpp>
29  * Contains utility functions for parsing JSON data.
32  * The parsing functions support optional usage of variables. JSON string values
35  * provides the variable values. Any variable in a JSON string value will be
38  * Variables can only appear in a JSON string value. The parsing functions for
52  * Returns the specified property of the specified JSON element.
56  * @param element JSON element
63 inline const nlohmann::json& getRequiredProperty(const nlohmann::json& element,  in getRequiredProperty()
76  * Parses a JSON element containing a bit position (from 0-7).
82  * @param element JSON element
87     const nlohmann::json& element,
91  * Parses a JSON element containing a bit value (0 or 1).
97  * @param element JSON element
102     const nlohmann::json& element,
106  * Parses a JSON element containing a boolean.
112  * @param element JSON element
117     const nlohmann::json& element,
121  * Parses a JSON element containing a double (floating point number).
127  * @param element JSON element
132     const nlohmann::json& element,
136  * Parses a JSON element containing a byte value expressed as a hexadecimal
139  * The JSON number data type does not support the hexadecimal format.  For this
140  * reason, a hexadecimal byte value is stored in a JSON string.
146  * @param element JSON element
151     const nlohmann::json& element,
155  * Parses a JSON element containing an array of byte values expressed as a
162  * @param element JSON element
167     const nlohmann::json& element,
171  * Parses a JSON element containing an 8-bit signed integer.
177  * @param element JSON element
182     const nlohmann::json& element,
186  * Parses a JSON element containing an integer.
192  * @param element JSON element
197     const nlohmann::json& element,
201  * Parses a JSON element containing a string.
207  * @param element JSON element
213     const nlohmann::json& element, bool isEmptyValid = false,
217  * Parses a JSON element containing an 8-bit unsigned integer.
223  * @param element JSON element
228     const nlohmann::json& element,
232  * Parses a JSON element containing a 16-bit unsigned integer.
238  * @param element JSON element
243     const nlohmann::json& element,
247  * Parses a JSON element containing an unsigned integer.
253  * @param element JSON element
258     const nlohmann::json& element,
262  * Verifies that the specified JSON element is a JSON array.
266  * @param element JSON element
268 inline void verifyIsArray(const nlohmann::json& element)  in verifyIsArray()
277  * Verifies that the specified JSON element is a JSON object.
281  * @param element JSON element
283 inline void verifyIsObject(const nlohmann::json& element)  in verifyIsObject()
292  * Verifies that the specified JSON element contains the expected number of
299  * @param element JSON element
302 inline void verifyPropertyCount(const nlohmann::json& element,  in verifyPropertyCount()