build based on 6bb3390

dev/.documenter-siteinfo.json

@@ -1 +1 @@
-{"documenter":{"julia_version":"1.11.2","generation_timestamp":"2024-12-12T14:23:27","documenter_version":"1.8.0"}}
+{"documenter":{"julia_version":"1.11.2","generation_timestamp":"2025-01-09T15:57:25","documenter_version":"1.8.0"}}

dev/fmi2_lowlevel_CS_functions/index.html

@@ -15,4 +15,4 @@
                         s::fmi2StatusKind, 
                         value::Ref{fmi2Boolean})</code></pre><p>Informs the master about the actual status of the simulation run. Which status information is to be returned is specified by the argument <code>fmi2StatusKind</code>.</p><p><strong>Arguments</strong></p><ul><li><code>c::FMU2Component</code>: Mutable struct represents an instantiated instance of an FMU in the FMI 2.0.2 Standard.</li><li><code>s::fmi2StatusKind</code>: Argument <code>s</code> defines which status information is to be returned. <code>fmi2StatusKind</code> is an enumeration that defines which status is inquired.</li></ul><p>The following status information can be retrieved from a slave:</p><ul><li><code>fmi2DoStepStatus::fmi2Status</code>: Can be called when the <code>fmi2DoStep</code> function returned <code>fmi2Pending</code>. The function delivers <code>fmi2Pending</code> if the computation is not finished. Otherwise the function returns the result of the asynchronously executed <code>fmi2DoStep</code> call.</li><li><code>fmi2PendingStatus::fmi2String</code>: Can be called when the <code>fmi2DoStep</code> function returned <code>fmi2Pending</code>. The function delivers a string which informs about the status of the currently running asynchronous <code>fmi2DoStep</code> computation</li><li><code>fmi2LastSuccessfulTime:: fmi2Real</code>: Returns the end time of the last successfully completed communication step. Can be called after fmi2DoStep(..) returned fmi2Discard.</li><li><code>fmi2Terminated::fmi2Boolean</code>: Returns <code>fmi2True</code>, if the slave wants to terminate the simulation. Can be called after fmi2DoStep(..) returned <code>fmi2Discard</code>. Use fmi2LastSuccessfulTime to determine the time instant at which the slave terminated.</li><li><code>value::Ref{fmi2Boolean}</code>: Argument <code>value</code> points to the return value (fmi2Boolean) which was requested. <code>fmi2Boolean</code> is a alias type for <code>Boolean</code> data type.</li></ul><p><strong>Returns</strong></p><ul><li><code>status::fmi2Status</code>: Return <code>status</code> is an enumeration of type <code>fmi2Status</code> and indicates the success of the function call.</li></ul><p>More detailed:</p><ul><li><code>fmi2OK</code>: all well</li><li><code>fmi2Warning</code>: things are not quite right, but the computation can continue</li><li><code>fmi2Discard</code>: if the slave computed successfully only a subinterval of the communication step</li><li><code>fmi2Error</code>: the communication step could not be carried out at all</li><li><code>fmi2Fatal</code>: if an error occurred which corrupted the FMU irreparably</li><li><code>fmi2Pending</code>: this status is returned if the slave executes the function asynchronously</li></ul><p><strong>Source</strong></p><ul><li>FMISpec2.0.2 Link: <a href="https://fmi-standard.org/">https://fmi-standard.org/</a></li><li>FMISpec2.0.2[p.16]: 2.1.2 Platform Dependent Definitions (fmi2TypesPlatform.h)</li><li>FMISpec2.0.2[p.16]: 2.1.3 Status Returned by Functions</li><li>FMISpec2.0.2[p.106]: 4.2.3 Retrieving Status Information from the Slave</li></ul><p>See also <a href="#FMICore.fmi2GetBooleanStatus!"><code>fmi2GetBooleanStatus!</code></a>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/ThummeTo/FMIImport.jl/blob/v1.0.8/src/FMI2/c.jl#L1506-L1538">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="FMICore.fmi2GetStringStatus!" href="#FMICore.fmi2GetStringStatus!"><code>FMICore.fmi2GetStringStatus!</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><p>Source: FMISpec2.0.2[p.106]: 4.2.3 Retrieving Status Information from the Slave</p><p>Informs the master about the actual status of the simulation run. Which status information is to be returned is specified by the argument fmi2StatusKind.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/ThummeTo/FMICore.jl/blob/v1.1.1/src/FMI2/cfunc.jl#L764-L768">source</a></section><section><div><pre><code class="language-julia hljs">fmi2GetStringStatus!(c::FMU2Component, 
                         s::fmi2StatusKind, 
-                        value::Ref{fmi2String})</code></pre><p>Informs the master about the actual status of the simulation run. Which status information is to be returned is specified by the argument <code>fmi2StatusKind</code>.</p><p><strong>Arguments</strong></p><ul><li><code>c::FMU2Component</code>: Mutable struct represents an instantiated instance of an FMU in the FMI 2.0.2 Standard.</li><li><code>s::fmi2StatusKind</code>: Argument <code>s</code> defines which status information is to be returned. <code>fmi2StatusKind</code> is an enumeration that defines which status is inquired.</li></ul><p>The following status information can be retrieved from a slave:</p><ul><li><code>fmi2DoStepStatus::fmi2Status</code>: Can be called when the <code>fmi2DoStep</code> function returned <code>fmi2Pending</code>. The function delivers <code>fmi2Pending</code> if the computation is not finished. Otherwise the function returns the result of the asynchronously executed <code>fmi2DoStep</code> call.</li><li><code>fmi2PendingStatus::fmi2String</code>: Can be called when the <code>fmi2DoStep</code> function returned <code>fmi2Pending</code>. The function delivers a string which informs about the status of the currently running asynchronous <code>fmi2DoStep</code> computation</li><li><code>fmi2LastSuccessfulTime:: fmi2Real</code>: Returns the end time of the last successfully completed communication step. Can be called after fmi2DoStep(..) returned fmi2Discard.</li><li><code>fmi2Terminated::fmi2Boolean</code>: Returns <code>fmi2True</code>, if the slave wants to terminate the simulation. Can be called after fmi2DoStep(..) returned <code>fmi2Discard</code>. Use fmi2LastSuccessfulTime to determine the time instant at which the slave terminated.</li><li><code>value:Ref{fmi2String}:</code> Argument <code>value</code> points to the return value (fmi2String) which was requested. <code>fmi2String</code> is a alias type for <code>String</code> data type.</li></ul><p><strong>Returns</strong></p><ul><li><code>status::fmi2Status</code>: Return <code>status</code> is an enumeration of type <code>fmi2Status</code> and indicates the success of the function call.</li></ul><p>More detailed:</p><ul><li><code>fmi2OK</code>: all well</li><li><code>fmi2Warning</code>: things are not quite right, but the computation can continue</li><li><code>fmi2Discard</code>: if the slave computed successfully only a subinterval of the communication step</li><li><code>fmi2Error</code>: the communication step could not be carried out at all</li><li><code>fmi2Fatal</code>: if an error occurred which corrupted the FMU irreparably</li><li><code>fmi2Pending</code>: this status is returned if the slave executes the function asynchronously</li></ul><p><strong>Source</strong></p><ul><li>FMISpec2.0.2 Link: <a href="https://fmi-standard.org/">https://fmi-standard.org/</a></li><li>FMISpec2.0.2[p.16]: 2.1.2 Platform Dependent Definitions (fmi2TypesPlatform.h)</li><li>FMISpec2.0.2[p.16]: 2.1.3 Status Returned by Functions</li><li>FMISpec2.0.2[p.106]: 4.2.3 Retrieving Status Information from the Slave</li></ul><p>See also <a href="#FMICore.fmi2GetStringStatus!"><code>fmi2GetStringStatus!</code></a>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/ThummeTo/FMIImport.jl/blob/v1.0.8/src/FMI2/c.jl#L1551-L1583">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../fmi2_lowlevel_ME_functions/">« FMI for Model Exchange</a><a class="docs-footer-nextpage" href="../fmi3_lowlevel_library_constants/">FMI3 Types in FMI Import/Core .jl »</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="Thursday 12 December 2024 14:23">Thursday 12 December 2024</span>. Using Julia version 1.11.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+                        value::Ref{fmi2String})</code></pre><p>Informs the master about the actual status of the simulation run. Which status information is to be returned is specified by the argument <code>fmi2StatusKind</code>.</p><p><strong>Arguments</strong></p><ul><li><code>c::FMU2Component</code>: Mutable struct represents an instantiated instance of an FMU in the FMI 2.0.2 Standard.</li><li><code>s::fmi2StatusKind</code>: Argument <code>s</code> defines which status information is to be returned. <code>fmi2StatusKind</code> is an enumeration that defines which status is inquired.</li></ul><p>The following status information can be retrieved from a slave:</p><ul><li><code>fmi2DoStepStatus::fmi2Status</code>: Can be called when the <code>fmi2DoStep</code> function returned <code>fmi2Pending</code>. The function delivers <code>fmi2Pending</code> if the computation is not finished. Otherwise the function returns the result of the asynchronously executed <code>fmi2DoStep</code> call.</li><li><code>fmi2PendingStatus::fmi2String</code>: Can be called when the <code>fmi2DoStep</code> function returned <code>fmi2Pending</code>. The function delivers a string which informs about the status of the currently running asynchronous <code>fmi2DoStep</code> computation</li><li><code>fmi2LastSuccessfulTime:: fmi2Real</code>: Returns the end time of the last successfully completed communication step. Can be called after fmi2DoStep(..) returned fmi2Discard.</li><li><code>fmi2Terminated::fmi2Boolean</code>: Returns <code>fmi2True</code>, if the slave wants to terminate the simulation. Can be called after fmi2DoStep(..) returned <code>fmi2Discard</code>. Use fmi2LastSuccessfulTime to determine the time instant at which the slave terminated.</li><li><code>value:Ref{fmi2String}:</code> Argument <code>value</code> points to the return value (fmi2String) which was requested. <code>fmi2String</code> is a alias type for <code>String</code> data type.</li></ul><p><strong>Returns</strong></p><ul><li><code>status::fmi2Status</code>: Return <code>status</code> is an enumeration of type <code>fmi2Status</code> and indicates the success of the function call.</li></ul><p>More detailed:</p><ul><li><code>fmi2OK</code>: all well</li><li><code>fmi2Warning</code>: things are not quite right, but the computation can continue</li><li><code>fmi2Discard</code>: if the slave computed successfully only a subinterval of the communication step</li><li><code>fmi2Error</code>: the communication step could not be carried out at all</li><li><code>fmi2Fatal</code>: if an error occurred which corrupted the FMU irreparably</li><li><code>fmi2Pending</code>: this status is returned if the slave executes the function asynchronously</li></ul><p><strong>Source</strong></p><ul><li>FMISpec2.0.2 Link: <a href="https://fmi-standard.org/">https://fmi-standard.org/</a></li><li>FMISpec2.0.2[p.16]: 2.1.2 Platform Dependent Definitions (fmi2TypesPlatform.h)</li><li>FMISpec2.0.2[p.16]: 2.1.3 Status Returned by Functions</li><li>FMISpec2.0.2[p.106]: 4.2.3 Retrieving Status Information from the Slave</li></ul><p>See also <a href="#FMICore.fmi2GetStringStatus!"><code>fmi2GetStringStatus!</code></a>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/ThummeTo/FMIImport.jl/blob/v1.0.8/src/FMI2/c.jl#L1551-L1583">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../fmi2_lowlevel_ME_functions/">« FMI for Model Exchange</a><a class="docs-footer-nextpage" href="../fmi3_lowlevel_library_constants/">FMI3 Types in FMI Import/Core .jl »</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="Thursday 9 January 2025 15:57">Thursday 9 January 2025</span>. Using Julia version 1.11.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>