CDIXMLGenerator Class Reference

Standalone utility class for generating the XML representation of the node configuration structure. More...

#include <CDIXMLGenerator.hxx>

Static Public Member Functions
template<class ConfigDef >
static bool	create_config_descriptor_xml (const ConfigDef &config, const char *filename, openlcb::SimpleStackBase *stack=nullptr)
	Creates the XML representation of the configuration structure and saves it to a file on the filesystem.

Detailed Description

Standalone utility class for generating the XML representation of the node configuration structure.

This is primarily used in Arduino environments.

Definition at line 43 of file CDIXMLGenerator.hxx.

Member Function Documentation

create_config_descriptor_xml()

template<class ConfigDef >

static bool CDIXMLGenerator::create_config_descriptor_xml ( const ConfigDef &  config, const char *  filename, openlcb::SimpleStackBase *  stack = nullptr  )

inlinestatic

Creates the XML representation of the configuration structure and saves it to a file on the filesystem.

Must be called after SPIFFS.begin() but before calling the {} method. The config file will be re-written whenever there was a change in the contents. It is also necessary to declare the static compiled-in CDI to be empty: namespace openlcb { // This will stop openlcb from exporting the CDI memory space // upon start. extern const char CDI_DATA[] = ""; } // namespace openlcb cfg is the global configuration instance (usually called cfg). filename is where the xml file can be stored on the filesystem. For example "/spiffs/cdi.xml". true if the configuration xml file was modified by this method, false if the file was already up-to-date.

Definition at line 65 of file CDIXMLGenerator.hxx.

---

The documentation for this class was generated from the following file:

• CDIXMLGenerator.hxx