build based on 4108c2b

previews/PR342/.documenter-siteinfo.json

@@ -1 +1 @@
-{"documenter":{"julia_version":"1.11.2","generation_timestamp":"2024-12-06T20:36:34","documenter_version":"1.8.0"}}
+{"documenter":{"julia_version":"1.11.2","generation_timestamp":"2024-12-07T00:17:45","documenter_version":"1.8.0"}}

previews/PR342/dev_guide/components_and_container/index.html

@@ -6,4 +6,4 @@
 # Optional
 get_ext(c::MyComponent) = InfrastructureSystems.get_ext(c.ext)
 clear_ext!(c::MyComponent) = InfrastructureSystems.clear_ext(c.ext)</code></pre><ol><li>Implement this function with <code>true</code> or <code>false</code> depending on whether your component type will support time series data. The default method returns <code>false</code>.</li></ol><pre><code class="language-julia hljs">supports_time_series(::MyComponent) = true</code></pre><ol><li>Implement this function with <code>true</code> or <code>false</code> depending on whether your component type will support supplemental attributes. The default method returns <code>true</code>.</li></ol><pre><code class="language-julia hljs">supports_supplemental_attributes(::MyComponent) = true</code></pre><p><em>Notes</em>:</p><ul><li><a href="../../InfrastructureSystems/#InfrastructureSystems.get_uuid-Tuple{InfrastructureSystems.InfrastructureSystemsType}"><code>InfrastructureSystems.get_uuid</code></a> with argument <code>obj::InfrastructureSystemsComponent</code> returns the component UUID.</li><li>The extension dictionary is not created until the first time <code>get_ext</code> is called.</li></ul><h2 id="Interface-requirements"><a class="docs-heading-anchor" href="#Interface-requirements">Interface requirements</a><a id="Interface-requirements-1"></a><a class="docs-heading-anchor-permalink" href="#Interface-requirements" title="Permalink"></a></h2><p>Implement these methods for every struct.</p><ul><li><code>get_internal(c::MyComponent)::InfrastructureSystemsInternal</code></li><li><code>get_name(c::MyComponent)::String</code></li></ul><p>If the struct supports time series (default is false):</p><ul><li><code>supports_time_series(::MyComponent) = true</code></li></ul><h2 id="Component-Container"><a class="docs-heading-anchor" href="#Component-Container">Component Container</a><a id="Component-Container-1"></a><a class="docs-heading-anchor-permalink" href="#Component-Container" title="Permalink"></a></h2><p><code>InfrastructureSystems.jl</code> provides the <code>SystemData</code> struct to store a collection of components.</p><p>It is recommended but not required that you include this struct within your own system struct for these reasons:</p><ul><li>Provides search and iteration with <a href="../../InfrastructureSystems/#InfrastructureSystems.get_component"><code>InfrastructureSystems.get_component</code></a> and <a href="../../InfrastructureSystems/#InfrastructureSystems.get_components"><code>InfrastructureSystems.get_components</code></a> for abstract and concrete types.</li><li>Enforces name uniqueness within a concrete type.</li><li>Allows for component field validation.</li><li>Enables component JSON serialization and deserialization.</li></ul><h2 id="Instructions-on-how-to-use-the-SystemData-container"><a class="docs-heading-anchor" href="#Instructions-on-how-to-use-the-SystemData-container">Instructions on how to use the <code>SystemData</code> container</a><a id="Instructions-on-how-to-use-the-SystemData-container-1"></a><a class="docs-heading-anchor-permalink" href="#Instructions-on-how-to-use-the-SystemData-container" title="Permalink"></a></h2><ol><li>Add an instance of <code>SystemData</code> to your system struct.</li><li>Optionally pass a component validation descriptor file to the constructor.</li><li>Optionally pass <code>time_series_in_memory = true</code> to the constructor if you know that all time series data will fit in memory and want a performance boost.</li><li>Redirect these function calls to your instance of SystemData.</li></ol><ul><li><code>add_component!</code></li><li><code>remove_component!</code></li><li><code>get_component</code></li><li><code>get_components</code></li><li><code>get_components_by_name</code></li><li><code>add_time_series!</code></li></ul><h2 id="Importing-InfrastructureSystems-methods"><a class="docs-heading-anchor" href="#Importing-InfrastructureSystems-methods">Importing InfrastructureSystems methods</a><a id="Importing-InfrastructureSystems-methods-1"></a><a class="docs-heading-anchor-permalink" href="#Importing-InfrastructureSystems-methods" title="Permalink"></a></h2><p>It is recommended that you perform redirection on methods that act on <code>SystemData</code> so that those methods don&#39;t show up in <code>Julia</code> help or in <code>methods</code> output. For example:</p><pre><code class="language-julia hljs">get_time_series_resolution(sys::MySystem) =
-    InfrastructureSystems.get_time_series_resolution(sys.data)</code></pre><p>On the other hand, it is recommended that you import methods that act on an <code>InfrastructureSystemsComponent</code> into your package&#39;s namespace so that you don&#39;t have to duplicate docstrings and perform redirection. For example:</p><pre><code class="language-julia hljs">import InfrastructureSystems: get_time_series</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../../">« Welcome Page</a><a class="docs-footer-nextpage" href="../auto_generation/">Auto-Generation of Component Structs »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.8.0 on <span class="colophon-date" title="Friday 6 December 2024 20:36">Friday 6 December 2024</span>. Using Julia version 1.11.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+    InfrastructureSystems.get_time_series_resolution(sys.data)</code></pre><p>On the other hand, it is recommended that you import methods that act on an <code>InfrastructureSystemsComponent</code> into your package&#39;s namespace so that you don&#39;t have to duplicate docstrings and perform redirection. For example:</p><pre><code class="language-julia hljs">import InfrastructureSystems: get_time_series</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../../">« Welcome Page</a><a class="docs-footer-nextpage" href="../auto_generation/">Auto-Generation of Component Structs »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.8.0 on <span class="colophon-date" title="Saturday 7 December 2024 00:17">Saturday 7 December 2024</span>. Using Julia version 1.11.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

previews/PR342/dev_guide/logging/index.html

@@ -70,4 +70,4 @@
     @info "hello" maxlog = 2
     @warn "beware" maxlog = 2
 end
-@info report_log_summary(logger)</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../tests/">« Running Tests</a><a class="docs-footer-nextpage" href="../../style/">Style Guide »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.8.0 on <span class="colophon-date" title="Friday 6 December 2024 20:36">Friday 6 December 2024</span>. Using Julia version 1.11.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+@info report_log_summary(logger)</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../tests/">« Running Tests</a><a class="docs-footer-nextpage" href="../../style/">Style Guide »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.8.0 on <span class="colophon-date" title="Saturday 7 December 2024 00:17">Saturday 7 December 2024</span>. Using Julia version 1.11.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>