<trclass="memdesc:"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Wrapper class for managing strongly-typed configuration structures. <ahref="classfourdst_1_1config_1_1_config.html#details">More...</a><br/></td></tr>
<trclass="memdesc:"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Type trait to determine if a type is a <aclass="el"href="classfourdst_1_1config_1_1_config.html"title="Wrapper class for managing strongly-typed configuration structures.">Config</a> wrapper. <ahref="structfourdst_1_1config_1_1is__config__wrapper.html#details">More...</a><br/></td></tr>
<trclass="memitem:"><tdclass="memItemLeft"align="right"valign="top">struct  </td><tdclass="memItemRight"valign="bottom"><aclass="el"href="structfourdst_1_1config_1_1is__config__wrapper_3_01_config_3_01_t_01_4_01_4.html">is_config_wrapper< Config< T >></a></td></tr>
<trclass="memdesc:"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Specialization of <code><aclass="el"href="structfourdst_1_1config_1_1is__config__wrapper.html"title="Type trait to determine if a type is a Config wrapper.">is_config_wrapper</a></code> for <code><aclass="el"href="classfourdst_1_1config_1_1_config.html"title="Wrapper class for managing strongly-typed configuration structures.">Config</a><T></code>. <ahref="structfourdst_1_1config_1_1is__config__wrapper_3_01_config_3_01_t_01_4_01_4.html#details">More...</a><br/></td></tr>
<trclass="memdesc:"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Concept ensuring a type is suitable for configuration schema. <br/></td></tr>
<trclass="memdesc:"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Concept that defines the requirements for a CLI application class. <br/></td></tr>
<trclass="memitem:a9870cefcd568dac301257ca35b73ab14"id="r_a9870cefcd568dac301257ca35b73ab14"><tdclass="memItemLeft"align="right"valign="top">enum class  </td><tdclass="memItemRight"valign="bottom"><aclass="el"href="#a9870cefcd568dac301257ca35b73ab14">RootNameLoadPolicy</a> { <aclass="el"href="#a9870cefcd568dac301257ca35b73ab14a0d7d491492131155ecdbcd14f592a729">FROM_FILE</a>
<trclass="memdesc:a9870cefcd568dac301257ca35b73ab14"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Policies for handling the root name during configuration loading. <ahref="#a9870cefcd568dac301257ca35b73ab14">More...</a><br/></td></tr>
<trclass="memitem:a18da8b2ec98ddd0a28e61644ce795b7e"id="r_a18da8b2ec98ddd0a28e61644ce795b7e"><tdclass="memItemLeft"align="right"valign="top">enum class  </td><tdclass="memItemRight"valign="bottom"><aclass="el"href="#a18da8b2ec98ddd0a28e61644ce795b7e">ConfigState</a> { <aclass="el"href="#a18da8b2ec98ddd0a28e61644ce795b7ea5b39c8b553c821e7cddc6da64b5bd2ee">DEFAULT</a>
<trclass="memdesc:a18da8b2ec98ddd0a28e61644ce795b7e"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Represents the current state of a Config object. <ahref="#a18da8b2ec98ddd0a28e61644ce795b7e">More...</a><br/></td></tr>
<p>Represents the current state of a <aclass="el"href="classfourdst_1_1config_1_1_config.html"title="Wrapper class for managing strongly-typed configuration structures.">Config</a> object. </p>
<tableclass="fieldtable">
<tr><thcolspan="2">Enumerator</th></tr><tr><tdclass="fieldname"><aid="a18da8b2ec98ddd0a28e61644ce795b7ea5b39c8b553c821e7cddc6da64b5bd2ee"name="a18da8b2ec98ddd0a28e61644ce795b7ea5b39c8b553c821e7cddc6da64b5bd2ee"></a>DEFAULT </td><tdclass="fielddoc"><p>Configuration contains default values and has not been loaded from a file. </p>
</td></tr>
<tr><tdclass="fieldname"><aid="a18da8b2ec98ddd0a28e61644ce795b7eac24435b28cc6d977d5d7804236dca3db"name="a18da8b2ec98ddd0a28e61644ce795b7eac24435b28cc6d977d5d7804236dca3db"></a>LOADED_FROM_FILE </td><tdclass="fielddoc"><p>Configuration has been successfully populated from a file. </p>
<p>Policies for handling the root name during configuration loading. </p>
<tableclass="fieldtable">
<tr><thcolspan="2">Enumerator</th></tr><tr><tdclass="fieldname"><aid="a9870cefcd568dac301257ca35b73ab14a0d7d491492131155ecdbcd14f592a729"name="a9870cefcd568dac301257ca35b73ab14a0d7d491492131155ecdbcd14f592a729"></a>FROM_FILE </td><tdclass="fielddoc"><p>Updates the internal root name to match what is found in the file. </p>
</td></tr>
<tr><tdclass="fieldname"><aid="a9870cefcd568dac301257ca35b73ab14a88b20772e9853307149861fa7e01e918"name="a9870cefcd568dac301257ca35b73ab14a88b20772e9853307149861fa7e01e918"></a>KEEP_CURRENT </td><tdclass="fielddoc"><p>Enforces the current internal root name; loading fails if the file's root name differs. </p>
<p>Registers configuration structure fields as CLI options. </p>
<p>This function iterates over the members of the provided configuration object using reflection and registers each member as a command-line option in the provided CLI application.</p>
<p>If the configuration object contains nested structures, field names are flattened using dot notation (e.g., <code>parent.child.field</code>).</p>
<p>If <code>T</code> is a <code><aclass="el"href="classfourdst_1_1config_1_1_config.html"title="Wrapper class for managing strongly-typed configuration structures.">Config</a><U></code> wrapper, it automatically unwraps the inner value and adds a footer note to the CLI application's help message indicating that options were auto-generated.</p>
<tr><tdclass="paramname">T</td><td>The type of the configuration object. Can be a raw struct or a <code><aclass="el"href="classfourdst_1_1config_1_1_config.html"title="Wrapper class for managing strongly-typed configuration structures.">Config</a><Struct></code> wrapper. </td></tr>
<tr><tdclass="paramname">CliApp</td><td>The type of the CLI application object. Must satisfy the <code><aclass="el"href="conceptfourdst_1_1config_1_1_is_c_l_i_app.html"title="Concept that defines the requirements for a CLI application class.">IsCLIApp</a></code> concept (e.g., <code>CLI::App</code>). </td></tr>
</table>
</dd>
</dl>
<dlclass="params"><dt>Parameters</dt><dd>
<tableclass="params">
<tr><tdclass="paramname">config</td><td>The configuration object to register. </td></tr>
<tr><tdclass="paramname">app</td><td>The CLI application instance to add options to. </td></tr>
<tr><tdclass="paramname">prefix</td><td>Optional prefix for option names. Used internally for recursion; usually omitted by the caller.</td></tr>
</table>
</dd>
</dl>
<dlclass="section user"><dt>Examples</dt><dd>Basic usage with CLI11: <divclass="fragment"><divclass="line"><spanclass="preprocessor">#include "CLI/CLI.hpp"</span></div>
<divclass="ttc"id="aclassfourdst_1_1config_1_1_config_html"><divclass="ttname"><ahref="classfourdst_1_1config_1_1_config.html">fourdst::config::Config</a></div><divclass="ttdoc">Wrapper class for managing strongly-typed configuration structures.</div><divclass="ttdef"><b>Definition</b> base.h:113</div></div>
<divclass="ttc"id="aconfig_8h_html"><divclass="ttname"><ahref="config_8h.html">config.h</a></div><divclass="ttdoc">Main entry point for the fourdst::config library.</div></div>
<liclass="footer">Generated by <ahref="https://www.doxygen.org/index.html"><imgclass="footer"src="doxygen.svg"width="104"height="31"alt="doxygen"/></a> 1.13.2 </li>