phosphor-regulators/src/config_file_parser.hpp

49 #include <nlohmann/json.hpp>
63  * Parses the specified JSON configuration file.
83  * Returns the specified property of the specified JSON element.
87  * @param element JSON element
94 inline const nlohmann::json& getRequiredProperty(const nlohmann::json& element,  in getRequiredProperty()
107  * Parses a JSON element containing an action.
113  * @param element JSON element
116 std::unique_ptr<Action> parseAction(const nlohmann::json& element);
119  * Parses a JSON element containing an array of actions.
125  * @param element JSON element
129     const nlohmann::json& element);
132  * Parses a JSON element containing an and action.
138  * @param element JSON element
141 std::unique_ptr<AndAction> parseAnd(const nlohmann::json& element);
144  * Parses a JSON element containing a bit position (from 0-7).
150  * @param element JSON element
153 inline uint8_t parseBitPosition(const nlohmann::json& element)  in parseBitPosition()
169  * Parses a JSON element containing a bit value (0 or 1).
175  * @param element JSON element
178 inline uint8_t parseBitValue(const nlohmann::json& element)  in parseBitValue()
194  * Parses a JSON element containing a boolean.
200  * @param element JSON element
203 inline bool parseBoolean(const nlohmann::json& element)  in parseBoolean()
214  * Parses a JSON element containing a chassis.
220  * @param element JSON element
223 std::unique_ptr<Chassis> parseChassis(const nlohmann::json& element);
226  * Parses a JSON element containing an array of chassis.
232  * @param element JSON element
236     const nlohmann::json& element);
239  * Parses a JSON element containing a compare_presence action.
245  * @param element JSON element
249     const nlohmann::json& element);
252  * Parses a JSON element containing a compare_vpd action.
258  * @param element JSON element
262     const nlohmann::json& element);
265  * Parses a JSON element containing a configuration object.
271  * @param element JSON element
275     const nlohmann::json& element);
278  * Parses a JSON element containing a device.
284  * @param element JSON element
287 std::unique_ptr<Device> parseDevice(const nlohmann::json& element);
290  * Parses a JSON element containing an array of devices.
296  * @param element JSON element
300     const nlohmann::json& element);
303  * Parses a JSON element containing a double (floating point number).
309  * @param element JSON element
312 inline double parseDouble(const nlohmann::json& element)  in parseDouble()
323  * Parses a JSON element containing a byte value expressed as a hexadecimal
326  * The JSON number data type does not support the hexadecimal format.  For this
334  * @param element JSON element
337 inline uint8_t parseHexByte(const nlohmann::json& element)  in parseHexByte()
357  * Parses a JSON element containing an array of byte values expressed as a
364  * @param element JSON element
367 std::vector<uint8_t> parseHexByteArray(const nlohmann::json& element);
370  * Parses a JSON element containing an i2c_capture_bytes action.
376  * @param element JSON element
380     const nlohmann::json& element);
383  * Parses a JSON element containing an i2c_compare_bit action.
389  * @param element JSON element
393     const nlohmann::json& element);
396  * Parses a JSON element containing an i2c_compare_byte action.
402  * @param element JSON element
406     const nlohmann::json& element);
409  * Parses a JSON element containing an i2c_compare_bytes action.
415  * @param element JSON element
419     const nlohmann::json& element);
422  * Parses a JSON element containing an i2c_interface.
428  * @param element JSON element
432     const nlohmann::json& element);
435  * Parses a JSON element containing an i2c_write_bit action.
441  * @param element JSON element
445     const nlohmann::json& element);
448  * Parses a JSON element containing an i2c_write_byte action.
454  * @param element JSON element
458     const nlohmann::json& element);
461  * Parses a JSON element containing an i2c_write_bytes action.
467  * @param element JSON element
471     const nlohmann::json& element);
474  * Parses a JSON element containing an if action.
480  * @param element JSON element
483 std::unique_ptr<IfAction> parseIf(const nlohmann::json& element);
486  * Parses a JSON element containing an 8-bit signed integer.
492  * @param element JSON element
495 inline int8_t parseInt8(const nlohmann::json& element)  in parseInt8()
511  * Parses a JSON element containing a relative inventory path.
515  * Inventory paths in the JSON configuration file are relative.  Adds the
520  * @param element JSON element
523 std::string parseInventoryPath(const nlohmann::json& element);
526  * Parses a JSON element containing a log_phase_fault action.
532  * @param element JSON element
536     const nlohmann::json& element);
539  * Parses a JSON element containing a not action.
545  * @param element JSON element
548 std::unique_ptr<NotAction> parseNot(const nlohmann::json& element);
551  * Parses a JSON element containing an or action.
557  * @param element JSON element
560 std::unique_ptr<OrAction> parseOr(const nlohmann::json& element);
563  * Parses a JSON element containing a phase_fault_detection object.
569  * @param element JSON element
573     const nlohmann::json& element);
576  * Parses a JSON element containing a PhaseFaultType expressed as a string.
582  * @param element JSON element
585 PhaseFaultType parsePhaseFaultType(const nlohmann::json& element);
588  * Parses a JSON element containing a pmbus_read_sensor action.
594  * @param element JSON element
598     const nlohmann::json& element);
601  * Parses a JSON element containing a pmbus_write_vout_command action.
607  * @param element JSON element
611     const nlohmann::json& element);
614  * Parses a JSON element containing a presence_detection object.
620  * @param element JSON element
624     const nlohmann::json& element);
627  * Parses a JSON element containing a rail.
633  * @param element JSON element
636 std::unique_ptr<Rail> parseRail(const nlohmann::json& element);
639  * Parses a JSON element containing an array of rails.
645  * @param element JSON element
649     const nlohmann::json& element);
652  * Parses the JSON root element of the entire configuration file.
658  * @param element JSON element
663     parseRoot(const nlohmann::json& element);
666  * Parses a JSON element containing a rule.
672  * @param element JSON element
675 std::unique_ptr<Rule> parseRule(const nlohmann::json& element);
678  * Parses a JSON element containing an array of rules.
684  * @param element JSON element
688     const nlohmann::json& element);
691  * Parses the "rule_id" or "actions" property in a JSON element.
703  * @param element JSON element
707     const nlohmann::json& element);
710  * Parses a JSON element containing a run_rule action.
716  * @param element JSON element
719 std::unique_ptr<RunRuleAction> parseRunRule(const nlohmann::json& element);
722  * Parses a JSON element containing a SensorDataFormat expressed as a string.
728  * @param element JSON element
732     const nlohmann::json& element);
735  * Parses a JSON element containing a sensor_monitoring object.
741  * @param element JSON element
745     const nlohmann::json& element);
748  * Parses a JSON element containing a SensorType expressed as a string.
754  * @param element JSON element
757 SensorType parseSensorType(const nlohmann::json& element);
760  * Parses a JSON element containing a set_device action.
766  * @param element JSON element
769 std::unique_ptr<SetDeviceAction> parseSetDevice(const nlohmann::json& element);
772  * Parses a JSON element containing a string.
778  * @param element JSON element
782 inline std::string parseString(const nlohmann::json& element,  in parseString()
798  * Parses a JSON element containing an 8-bit unsigned integer.
804  * @param element JSON element
807 inline uint8_t parseUint8(const nlohmann::json& element)  in parseUint8()
823  * Parses a JSON element containing an unsigned integer.
829  * @param element JSON element
832 inline unsigned int parseUnsignedInteger(const nlohmann::json& element)  in parseUnsignedInteger()
843  * Parses a JSON element containing a VoutDataFormat expressed as a string.
849  * @param element JSON element
852 pmbus_utils::VoutDataFormat parseVoutDataFormat(const nlohmann::json& element);
855  * Verifies that the specified JSON element is a JSON array.
859  * @param element JSON element
861 inline void verifyIsArray(const nlohmann::json& element)  in verifyIsArray()
870  * Verifies that the specified JSON element is a JSON object.
874  * @param element JSON element
876 inline void verifyIsObject(const nlohmann::json& element)  in verifyIsObject()
885  * Verifies that the specified JSON element contains the expected number of
892  * @param element JSON element
895 inline void verifyPropertyCount(const nlohmann::json& element,  in verifyPropertyCount()