====== 03 Requests ======

//These events are not part of the DQMH default features and have to be implemented manually in every HSE DQMH module.//


===== 'Configure' Request =====

> Triggers the auto-configuration of the module.

  * Lets the module configure itself
  * The connector pane has to be generic (i.e. only error in / error out) so that this VI can be called dynamically
  * The default behaviour of the 'configure' MHL case is to read the module's configuration data from the configuration directory (see [[code:common:project-structure|Project Structure]] and [[code:open-source:hse-libraries:hse-configuration|hse-configuration]] for details).

{{:kb:labview-frameworks:dqmh:dqmh-configure.png?400|}}

<WRAP left round important 80%>
The 'Configure' Request does **not** wait for a reply! Therefore, it should not be used for tasks which might take longer, like configuring hardware, establishing a connection etc. which should be triggered by a separate Request with wait for reply to avoid trying to work with the module before it is ready.
</WRAP>

---- 

===== 'Prepare' Request =====

> Prepares the module for displaying its front panel.

  * meant to be called when the front panel needs specific updating (usually before being shown):
    * {{:kb:labview-frameworks:dqmh:dqmh-prepare.png?400|}}

  * used in conjunction with our [[code:dqmh:hse-application-template|Windows Application Template]] when the "Request UI Display" case needs the module to execute code in preparation to showing the front panel (eg reset controls, show a password dialog, etc). The framework calls "Request UI Display", which in turn calls "Prepare", which then tidies the FP and executes the original display request:
    * {{:kb:labview-frameworks:dqmh:prepare-1.png?400|}}
    * {{:kb:labview-frameworks:dqmh:prepare-2.png?400|}}

---- 

===== 'Request UI Display' Request and Wait for Reply =====

> Requests a module to display its UI as specified in the parameter ''Scenario''. The module can either ignore or accept the request.

If the requested scenario is "stand-alone", the module simply shows its front panel as a new floating window. If the requested scenario is "managed", the FP is inserted into a subpanel of ''PROJECT_Layout-VI.vi'' (no new window pops up). 

For the "managed" scenario, the module will send a ''System Message'' broadcast with the ''Ready for Display'' message, which will be processed by the UI Manager module. To easily create the correct broadcast, the VI ''hse-dqmh.lvlib:DQMH System Message - Ready for Display.vi'' is proposed to be used.  

More details can be found at the [[code:dqmh:hse-application-template|HSE Windows Application Template]] project.

{{:kb:labview-frameworks:dqmh:ready_for_display.png|}}

=== Parameters ===

  * //Main VI Reference:// VI reference to the VI that wants to be displayed. Usually the "Main.vi".
  * //Title:// The title (e.g. module name) that should be displayed in the app header.
  * //Target SP Name:// Name of the subpanel in which the front panel should be inserted. Default is "SP_Content", the default subpanel from the HSE-App-Template.


**Note:** The connector pattern shown above is also necessary for DQMH 5.0, which introduces new connector patterns for Request and Wait for Reply events.

{{:code:dqmh:dqmh-requestuidisplay.png?600|}}