1. Project description

No description found (add content in project description)

2. DQMH® modules

This section describes DQMH® module responsibilities and relationships.

2.1. Preamble

A DQMH module is the main component of an architecture based on DQMH® framework. A DQMH module is used to implement a section of the application that has one responsibility.

DQMH® framework defines two different type of DQMH module.

Singleton:

A Singleton DQMH module can have only one instance running at any given time.

Cloneable:

A Cloneable DQMH module can have one or multiple instances running in parallel.

DQMH® framework defines two different ways to carry data throughout the application and with both other DQMH modules and non-DQMH based code.

Request events:

A request is a code that fires an event requesting the DQMH module to do something. Multiple locations in the code can send events to the DQMH module.

Request events are many-to-one.

Requests are usually named using imperative tense.

Broadcast events:

A broadcast is a code that fires an event broadcasting that the DQMH module did something. Multiple Event Structures can register to handle the Broadcast Events.

Broadcast Events are one-to-many.

Broadcasts are usually named using past tense or passive voice.

Note
Refer to the DQMH® framework official documentation to find more details on how the framework works

The following section gives you details on the project architecture relying on this framework. It gives you an overview of the modules' interaction and detailed information on each module.

Graphs used in this section have the following legend:

Components:

Diagram

Events:

Diagram
Note

One arrow can represent one or more events between two components

Note

Request and Request and wait for Reply are represented by only one arrow. If there is no Request and wait for Reply, Request representation is used. Otherwise Request and wait for Reply is used

Start and Stop module callers:

Diagram
Diagram

2.2. Modules overview

This project contains 4 singleton modules and 0 cloneable module.

Table 1. Modules list
Singleton Cloneable

CML UI.lvlib

Acquisition.lvlib

Logger.lvlib

Settings Editor.lvlib

This graph represents the links between all DQMH modules.

Diagram

2.3. CML UI.lvlib

Type: Singleton

Responsibility: No description found (add content in DQMH module lvlib description)

2.3.1. Event list

Table 2. Events
Name Type Connector pane Description S. R. I.

Start Module

empty.png

CML UI.lvlib:Start Module.vi

Launches the Module Main.vi.

empty.png

empty.png

empty.png

Stop Module

empty.png

CML UI.lvlib:Stop Module.vi

Send the Stop request to the Module's Main.vi.

If Wait for Module to Stop? is TRUE, this VI will wait until the module main VI stops, and will timeout at the Timeout to Wait for Stop value. This value defaults to "-1", which means the VI will not timeout, and will always wait until the module main VI stops before completing execution.

Note: The Timeout to Wait for Stop value is ignored if 'Wait for Module to Stop?' is set to FALSE.

empty.png

empty.png

empty.png

Show Panel

request.png

CML UI.lvlib:Show Panel.vi

Send the Show Panel request to the Module's Main.vi.

empty.png

empty.png

empty.png

Hide Panel

request.png

CML UI.lvlib:Hide Panel.vi

Send the Hide Panel request to the Module's Main.vi.

empty.png

empty.png

empty.png

Get Module Execution Status

request.png

CML UI.lvlib:Get Module Execution Status.vi

Fire the Get Module Execution Status request.

empty.png

empty.png

empty.png

Show Diagram

request.png

CML UI.lvlib:Show Diagram.vi

This VI tells the Module to show its block diagram to facilitate troubleshooting (add probes, breakpoints, highlight execution, etc).

empty.png

empty.png

empty.png

Module Did Init

broadcast.png

CML UI.lvlib:Module Did Init.vi

Send the Module Did Init event to any VI registered to listen to this module's broadcast events.

empty.png

empty.png

empty.png

Status Updated

broadcast.png

CML UI.lvlib:Status Updated.vi

Send the Status Updated event to any VI registered to listen to events from the owning module.

empty.png

empty.png

empty.png

Error Reported

broadcast.png

CML UI.lvlib:Error Reported.vi

Send the Error Reported event to any VI registered to listen to events from the owning module.

empty.png

empty.png

empty.png

Module Did Stop

broadcast.png

CML UI.lvlib:Module Did Stop.vi

Send the Module Did Stop event to any VI registered to listen to this module's broadcast events.

empty.png

empty.png

empty.png

Update Module Execution Status

broadcast.png

CML UI.lvlib:Update Module Execution Status.vi

Broadcast event to specify whether or not the module is running.

empty.png

empty.png

empty.png

Type: request → Request | request and wait for reply → Request and Wait for Reply | broadcast → Broadcast

Scope: scope protected → Protected | scope community → Community

Reentrancy: reentrancy preallocated → Preallocated reentrancy | reentrancy shared → Shared reentrancy

Inlining: inlined → Inlined

2.3.2. Module relationship

Diagram
Table 3. Requests callers
Request Name Callers

Get Module Execution Status

CML UI.lvlib:Obtain Broadcast Events for Registration.vi
CML UI.lvlib:Start Module.vi

Hide Panel

Test CML UI API.vi

Show Diagram

Test CML UI API.vi

Show Panel

CML Main.vi
Test CML UI API.vi

Table 4. Broadcasts Listeners
Broadcast Name Listeners

Error Reported

Test CML UI API.vi
CML Main.vi

Module Did Init

Test CML UI API.vi
CML Main.vi

Module Did Stop

Test CML UI API.vi
CML Main.vi

Status Updated

Test CML UI API.vi
CML Main.vi

Update Module Execution Status

Test CML UI API.vi
CML Main.vi

Table 5. Used requests
Module Requests

Acquisition.lvlib

Calibrate DAQ.vi
Get Module Execution Status.vi
Start Acquiring.vi
Stop Acquiring.vi
Stop Module.vi (2)

CML UI.lvlib

Stop Module.vi

Logger.lvlib

Get Module Execution Status.vi
Initialize File.vi
Stop Logging.vi
Stop Module.vi (2)

Settings Editor.lvlib

Get Module Execution Status.vi
Show Panel.vi
Stop Module.vi (2)

Table 6. Registered broadcast
Module Broadcasts

Acquisition.lvlib

Acquisition Started.vi
Acquisition Stopped.vi
Data Updated.vi
Device Calibrated.vi
Error Reported.vi
Module Did Init.vi
Status Updated.vi
Update Module Execution Status.vi

Logger.lvlib

Error Reported.vi
Module Did Init.vi
Status Updated.vi
Update Module Execution Status.vi

Settings Editor.lvlib

Error Reported.vi
Module Did Init.vi
Status Updated.vi
Update Module Execution Status.vi

2.3.3. Module Start/Stop calls

Diagram
Table 7. Start and Stop module callers
Function Callers

Start Module

CML Main.vi
Test CML UI API.vi

Stop Module

CML UI.lvlib:Handle Exit.vi
CML Main.vi
Test CML UI API.vi

2.3.4. Module custom errors

Tip

Custom errors are added to the module via vi named *--error.vi.

Module CML UI.lvlib use the following custom errors:

Table 8. Custom errors
Name Code Description

Module Not Running

403681

%s Module is not running.

Module Not Stopped

403682

The Stop Module VI for the %s module timed out while waiting for the module main VI to stop. The module main VI may still be running.

Module Not Synced

403683

%s Module was unable to synchronize events.

Request and Wait for Reply Timeout

403686

%s

2.4. Acquisition.lvlib

Type: Singleton

Responsibility: No description found (add content in DQMH module lvlib description)

2.4.1. Event list

Table 9. Events
Name Type Connector pane Description S. R. I.

Start Module

empty.png

Acquisition.lvlib:Start Module.vi

Launches the Module Main.vi.

empty.png

empty.png

empty.png

Stop Module

empty.png

Acquisition.lvlib:Stop Module.vi

Send the Stop request to the Module's Main.vi.

If Wait for Module to Stop? is TRUE, this VI will wait until the module main VI stops, and will timeout at the Timeout to Wait for Stop value. This value defaults to "-1", which means the VI will not timeout, and will always wait until the module main VI stops before completing execution.

Note: The Timeout to Wait for Stop value is ignored if 'Wait for Module to Stop?' is set to FALSE.

empty.png

empty.png

empty.png

Show Panel

request.png

Acquisition.lvlib:Show Panel.vi

Send the Show Panel request to the Module's Main.vi.

empty.png

empty.png

empty.png

Hide Panel

request.png

Acquisition.lvlib:Hide Panel.vi

Send the Hide Panel request to the Module's Main.vi.

empty.png

empty.png

empty.png

Get Module Execution Status

request.png

Acquisition.lvlib:Get Module Execution Status.vi

Fire the Get Module Execution Status request.

empty.png

empty.png

empty.png

Show Diagram

request.png

Acquisition.lvlib:Show Diagram.vi

This VI tells the Module to show its block diagram to facilitate troubleshooting (add probes, breakpoints, highlight execution, etc).

empty.png

empty.png

empty.png

Stop Acquiring

request.png

Acquisition.lvlib:Stop Acquiring.vi

Requests the Acquisition Module to stop acquiring

empty.png

empty.png

empty.png

Calibrate DAQ

request.png

Acquisition.lvlib:Calibrate DAQ.vi

Add calibration routine, and linear slope and offset to the acquisition helper loop.

empty.png

empty.png

empty.png

Start Acquiring

request-and-wait-for-reply.png

Acquisition.lvlib:Start Acquiring.vi

Note: This VI was renamed by the DQMH Rename Event utility. Make sure the VI Description is updated to reflect the new event name, then delete this comment.

Requests Acquisition Module to start acquiring.

empty.png

empty.png

empty.png

Module Did Init

broadcast.png

Acquisition.lvlib:Module Did Init.vi

Send the Module Did Init event to any VI registered to listen to this module's broadcast events.

empty.png

empty.png

empty.png

Status Updated

broadcast.png

Acquisition.lvlib:Status Updated.vi

Send the Status Updated event to any VI registered to listen to events from the owning module.

empty.png

empty.png

empty.png

Error Reported

broadcast.png

Acquisition.lvlib:Error Reported.vi

Send the Error Reported event to any VI registered to listen to events from the owning module.

empty.png

empty.png

empty.png

Module Did Stop

broadcast.png

Acquisition.lvlib:Module Did Stop.vi

Send the Module Did Stop event to any VI registered to listen to this module's broadcast events.

empty.png

empty.png

empty.png

Update Module Execution Status

broadcast.png

Acquisition.lvlib:Update Module Execution Status.vi

Broadcast event to specify whether or not the module is running.

empty.png

empty.png

empty.png

Acquisition Started

broadcast.png

Acquisition.lvlib:Acquisition Started.vi

Broadcasts that the Acquisition Module started acquiring

empty.png

empty.png

empty.png

Acquisition Stopped

broadcast.png

Acquisition.lvlib:Acquisition Stopped.vi

Broadcasts that the Acquisition Module has stopped acquiring data.

empty.png

empty.png

empty.png

Data Updated

broadcast.png

Acquisition.lvlib:Data Updated.vi

Broadcasts the latest data acquired

empty.png

empty.png

empty.png

Device Calibrated

broadcast.png

Acquisition.lvlib:Device Calibrated.vi

Broadcasts that the Acquisition module calibrated the device.

empty.png

empty.png

empty.png

Wakeup Helper Loop

request.png

Acquisition.lvlib:Wakeup Helper Loop.vi

This is a private request to wake up the Helper Loop and start acquiring.

empty.png

empty.png

empty.png

Change Settings

request.png

Acquisition.lvlib:Change Settings.vi

Fire an event to change the hardware settings in the helper loop.

This is a private request event that should only be fired from within the Acquisition Module. If this request was public, other modules could call it and the Settings Editor would not get the notification that the values changed.

empty.png

empty.png

empty.png

Type: request → Request | request and wait for reply → Request and Wait for Reply | broadcast → Broadcast

Scope: scope protected → Protected | scope community → Community

Reentrancy: reentrancy preallocated → Preallocated reentrancy | reentrancy shared → Shared reentrancy

Inlining: inlined → Inlined

2.4.2. Module relationship

Diagram
Table 10. Requests callers
Request Name Callers

Calibrate DAQ

CML UI.lvlib:Main.vi
Test Acquisition API.vi

Change Settings

Acquisition.lvlib:Main.vi

Get Module Execution Status

Acquisition.lvlib:Obtain Broadcast Events for Registration.vi
Acquisition.lvlib:Start Module.vi

Hide Panel

Test Acquisition API.vi

Show Diagram

Test Acquisition API.vi

Show Panel

Test Acquisition API.vi

Start Acquiring

CML UI.lvlib:Main.vi
Test Acquisition API.vi

Stop Acquiring

CML UI.lvlib:Main.vi
Test Acquisition API.vi

Wakeup Helper Loop

Acquisition.lvlib:Main.vi

Table 11. Broadcasts Listeners
Broadcast Name Listeners

Acquisition Started

CML UI.lvlib:Main.vi
Test Acquisition API.vi

Acquisition Stopped

CML UI.lvlib:Main.vi
Test Acquisition API.vi

Data Updated

CML UI.lvlib:Main.vi
Test Acquisition API.vi

Device Calibrated

CML UI.lvlib:Main.vi
Test Acquisition API.vi

Error Reported

CML UI.lvlib:Main.vi
Test Acquisition API.vi

Module Did Init

CML UI.lvlib:Main.vi
Test Acquisition API.vi

Module Did Stop

Test Acquisition API.vi

Status Updated

CML UI.lvlib:Main.vi
Test Acquisition API.vi

Update Module Execution Status

CML UI.lvlib:Main.vi
Test Acquisition API.vi

Table 12. Used requests
Module Requests

Acquisition.lvlib

Change Settings.vi
Stop Module.vi
Wakeup Helper Loop.vi

Logger.lvlib

Log Data.vi

Settings Editor.lvlib

Get Module Execution Status.vi
Stop Module.vi (2)
Update Application Settings.vi

Table 13. Registered broadcast
Module Broadcasts

Settings Editor.lvlib

Application Settings Updated.vi

2.4.3. Module Start/Stop calls

Diagram
Table 14. Start and Stop module callers
Function Callers

Start Module

CML UI.lvlib:Main.vi
Test Acquisition API.vi

Stop Module

CML UI.lvlib:Main.vi
Acquisition.lvlib:Handle Exit.vi
Test Acquisition API.vi

2.4.4. Module custom errors

Tip

Custom errors are added to the module via vi named *--error.vi.

Module Acquisition.lvlib use the following custom errors:

Table 15. Custom errors
Name Code Description

Module Not Running

403681

%s Module is not running.

Module Not Stopped

403682

The Stop Module VI for the %s module timed out while waiting for the module main VI to stop. The module main VI may still be running.

Module Not Synced

403683

%s Module was unable to synchronize events.

Request and Wait for Reply Timeout

403686

%s

2.5. Logger.lvlib

Type: Singleton

Responsibility: No description found (add content in DQMH module lvlib description)

2.5.1. Event list

Table 16. Events
Name Type Connector pane Description S. R. I.

Start Module

empty.png

Logger.lvlib:Start Module.vi

Launches the Module Main.vi.

empty.png

empty.png

empty.png

Stop Module

empty.png

Logger.lvlib:Stop Module.vi

Send the Stop request to the Module's Main.vi.

If Wait for Module to Stop? is TRUE, this VI will wait until the module main VI stops, and will timeout at the Timeout to Wait for Stop value. This value defaults to "-1", which means the VI will not timeout, and will always wait until the module main VI stops before completing execution.

Note: The Timeout to Wait for Stop value is ignored if 'Wait for Module to Stop?' is set to FALSE.

empty.png

empty.png

empty.png

Show Panel

request.png

Logger.lvlib:Show Panel.vi

Send the Show Panel request to the Module's Main.vi.

empty.png

empty.png

empty.png

Hide Panel

request.png

Logger.lvlib:Hide Panel.vi

Send the Hide Panel request to the Module's Main.vi.

empty.png

empty.png

empty.png

Get Module Execution Status

request.png

Logger.lvlib:Get Module Execution Status.vi

Fire the Get Module Execution Status request.

empty.png

empty.png

empty.png

Show Diagram

request.png

Logger.lvlib:Show Diagram.vi

This VI tells the Module to show its block diagram to facilitate troubleshooting (add probes, breakpoints, highlight execution, etc).

empty.png

empty.png

empty.png

Initialize File

request-and-wait-for-reply.png

Logger.lvlib:Initialize File.vi

Request the Logger to initialize the file and report when the Logger has initialized the file.

empty.png

empty.png

empty.png

Log Data

request.png

Logger.lvlib:Log Data.vi

Note: This VI was renamed by the DQMH Rename Event utility. Make sure the VI Description is updated to reflect the new event name, then delete this comment.

Requests Logger module to log data to file

empty.png

empty.png

empty.png

Stop Logging

request.png

Logger.lvlib:Stop Logging.vi

Requests Logger module to stop logging and the module broadcasts when the logging has stopped.

empty.png

empty.png

empty.png

Module Did Init

broadcast.png

Logger.lvlib:Module Did Init.vi

Send the Module Did Init event to any VI registered to listen to this module's broadcast events.

empty.png

empty.png

empty.png

Status Updated

broadcast.png

Logger.lvlib:Status Updated.vi

Send the Status Updated event to any VI registered to listen to events from the owning module.

empty.png

empty.png

empty.png

Error Reported

broadcast.png

Logger.lvlib:Error Reported.vi

Send the Error Reported event to any VI registered to listen to events from the owning module.

empty.png

empty.png

empty.png

Module Did Stop

broadcast.png

Logger.lvlib:Module Did Stop.vi

Send the Module Did Stop event to any VI registered to listen to this module's broadcast events.

empty.png

empty.png

empty.png

Update Module Execution Status

broadcast.png

Logger.lvlib:Update Module Execution Status.vi

Broadcast event to specify whether or not the module is running.

empty.png

empty.png

empty.png

Logging Stopped

broadcast.png

Logger.lvlib:Logging Stopped.vi

Requests Logger module to stop logging and the module broadcasts when the logging has stopped.

empty.png

empty.png

empty.png

File Initialized

broadcast.png

Logger.lvlib:File Initialized.vi

Request the Logger to initialize the file and report when the Logger has initialized the file.

empty.png

empty.png

empty.png

Type: request → Request | request and wait for reply → Request and Wait for Reply | broadcast → Broadcast

Scope: scope protected → Protected | scope community → Community

Reentrancy: reentrancy preallocated → Preallocated reentrancy | reentrancy shared → Shared reentrancy

Inlining: inlined → Inlined

2.5.2. Module relationship

Diagram
Table 17. Requests callers
Request Name Callers

Get Module Execution Status

Logger.lvlib:Obtain Broadcast Events for Registration.vi
Logger.lvlib:Start Module.vi

Hide Panel

Test Logger API.vi

Initialize File

CML UI.lvlib:Main.vi
Test Logger API.vi

Log Data

Acquisition.lvlib:Main.vi
Test Logger API.vi

Show Diagram

Test Logger API.vi

Show Panel

Test Logger API.vi

Stop Logging

CML UI.lvlib:Main.vi
Test Logger API.vi

Table 18. Broadcasts Listeners
Broadcast Name Listeners

Error Reported

CML UI.lvlib:Main.vi
Test Logger API.vi

File Initialized

Test Logger API.vi

Logging Stopped

Test Logger API.vi

Module Did Init

CML UI.lvlib:Main.vi
Test Logger API.vi

Module Did Stop

Test Logger API.vi

Status Updated

CML UI.lvlib:Main.vi
Test Logger API.vi

Update Module Execution Status

CML UI.lvlib:Main.vi
Test Logger API.vi

Table 19. Used requests
Module Requests

Logger.lvlib

Stop Module.vi

Settings Editor.lvlib

Get Module Execution Status.vi
Stop Module.vi (2)
Update Application Settings.vi

Table 20. Registered broadcast
Module Broadcasts

Settings Editor.lvlib

Application Settings Updated.vi

2.5.3. Module Start/Stop calls

Diagram
Table 21. Start and Stop module callers
Function Callers

Start Module

CML UI.lvlib:Main.vi
Test Logger API.vi

Stop Module

CML UI.lvlib:Main.vi
Logger.lvlib:Handle Exit.vi
Test Logger API.vi

2.5.4. Module custom errors

Tip

Custom errors are added to the module via vi named *--error.vi.

Module Logger.lvlib use the following custom errors:

Table 22. Custom errors
Name Code Description

Module Not Running

403681

%s Module is not running.

Module Not Stopped

403682

The Stop Module VI for the %s module timed out while waiting for the module main VI to stop. The module main VI may still be running.

Module Not Synced

403683

%s Module was unable to synchronize events.

Request and Wait for Reply Timeout

403686

%s

2.6. Settings Editor.lvlib

Type: Singleton

Responsibility: No description found (add content in DQMH module lvlib description)

2.6.1. Event list

Table 23. Events
Name Type Connector pane Description S. R. I.

Start Module

empty.png

Settings Editor.lvlib:Start Module.vi

Launches the Module Main.vi.

empty.png

empty.png

empty.png

Stop Module

empty.png

Settings Editor.lvlib:Stop Module.vi

Send the Stop request to the Module's Main.vi.

If Wait for Module to Stop? is TRUE, this VI will wait until the module main VI stops, and will timeout at the Timeout to Wait for Stop value. This value defaults to "-1", which means the VI will not timeout, and will always wait until the module main VI stops before completing execution.

Note: The Timeout to Wait for Stop value is ignored if 'Wait for Module to Stop?' is set to FALSE.

empty.png

empty.png

empty.png

Show Panel

request.png

Settings Editor.lvlib:Show Panel.vi

Send the Show Panel request to the Module's Main.vi.

empty.png

empty.png

empty.png

Hide Panel

request.png

Settings Editor.lvlib:Hide Panel.vi

Send the Hide Panel request to the Module's Main.vi.

empty.png

empty.png

empty.png

Get Module Execution Status

request.png

Settings Editor.lvlib:Get Module Execution Status.vi

Fire the Get Module Execution Status request.

empty.png

empty.png

empty.png

Show Diagram

request.png

Settings Editor.lvlib:Show Diagram.vi

This VI tells the Module to show its block diagram to facilitate troubleshooting (add probes, breakpoints, highlight execution, etc).

empty.png

empty.png

empty.png

Update Application Settings

request-and-wait-for-reply.png

Settings Editor.lvlib:Update Application Settings.vi

Request Settings Editor to return the latest settings. The Settings Editor can send the applications settings as a reply or via broadcast.

empty.png

empty.png

empty.png

Module Did Init

broadcast.png

Settings Editor.lvlib:Module Did Init.vi

Send the Module Did Init event to any VI registered to listen to this module's broadcast events.

empty.png

empty.png

empty.png

Status Updated

broadcast.png

Settings Editor.lvlib:Status Updated.vi

Send the Status Updated event to any VI registered to listen to events from the owning module.

empty.png

empty.png

empty.png

Error Reported

broadcast.png

Settings Editor.lvlib:Error Reported.vi

Send the Error Reported event to any VI registered to listen to events from the owning module.

empty.png

empty.png

empty.png

Module Did Stop

broadcast.png

Settings Editor.lvlib:Module Did Stop.vi

Send the Module Did Stop event to any VI registered to listen to this module's broadcast events.

empty.png

empty.png

empty.png

Update Module Execution Status

broadcast.png

Settings Editor.lvlib:Update Module Execution Status.vi

Broadcast event to specify whether or not the module is running.

empty.png

empty.png

empty.png

Application Settings Updated

broadcast.png

Settings Editor.lvlib:Application Settings Updated.vi

Request Settings Editor to return the latest settings. The Settings Editor can send the applications settings as a reply or via broadcast.

empty.png

empty.png

empty.png

Type: request → Request | request and wait for reply → Request and Wait for Reply | broadcast → Broadcast

Scope: scope protected → Protected | scope community → Community

Reentrancy: reentrancy preallocated → Preallocated reentrancy | reentrancy shared → Shared reentrancy

Inlining: inlined → Inlined

2.6.2. Module relationship

Diagram
Table 24. Requests callers
Request Name Callers

Get Module Execution Status

Settings Editor.lvlib:Obtain Broadcast Events for Registration.vi
Settings Editor.lvlib:Start Module.vi

Hide Panel

Test Settings Editor API.vi

Show Diagram

Test Settings Editor API.vi

Show Panel

CML UI.lvlib:Main.vi
Test Acquisition API.vi
Test Logger API.vi
Test Settings Editor API.vi

Update Application Settings

Acquisition.lvlib:Main.vi
Logger.lvlib:Main.vi
Test Settings Editor API.vi

Table 25. Broadcasts Listeners
Broadcast Name Listeners

Application Settings Updated

Acquisition.lvlib:Main.vi
Logger.lvlib:Main.vi
Test Settings Editor API.vi

Error Reported

CML UI.lvlib:Main.vi
Test Settings Editor API.vi

Module Did Init

CML UI.lvlib:Main.vi
Test Settings Editor API.vi

Module Did Stop

Test Settings Editor API.vi

Status Updated

CML UI.lvlib:Main.vi
Test Settings Editor API.vi

Update Module Execution Status

CML UI.lvlib:Main.vi
Test Settings Editor API.vi

Table 26. Used requests
Module Requests

Settings Editor.lvlib

Stop Module.vi

Table 27. Registered broadcast
Module Broadcasts

 — 

 — 

2.6.3. Module Start/Stop calls

Diagram
Table 28. Start and Stop module callers
Function Callers

Start Module

CML UI.lvlib:Main.vi
Acquisition.lvlib:Main.vi
Logger.lvlib:Main.vi
Test Settings Editor API.vi

Stop Module

CML UI.lvlib:Main.vi
Settings Editor.lvlib:Handle Exit.vi
Acquisition.lvlib:Main.vi
Logger.lvlib:Main.vi
Test Settings Editor API.vi

2.6.4. Module custom errors

Tip

Custom errors are added to the module via vi named *--error.vi.

Module Settings Editor.lvlib use the following custom errors:

Table 29. Custom errors
Name Code Description

Module Not Running

403681

%s Module is not running.

Module Not Stopped

403682

The Stop Module VI for the %s module timed out while waiting for the module main VI to stop. The module main VI may still be running.

Module Not Synced

403683

%s Module was unable to synchronize events.

Request and Wait for Reply Timeout

403686

%s

3. Libraries

This section describes the libraries contained in the project.

3.1. CML Shared.lvlib

Responsibility: No description found (add content in lvlib description)

Version: 1.0.0.0

This library has no functions set to non private scope.

3.2. Launcher Support.lvlib

Responsibility: No description found (add content in lvlib description)

Version: 1.0.0.0

Table 30. Functions (non private scope only)
Name Connector pane Description S. R. I.

Determine if Running in Debug Mode

Launcher Support.lvlib:Determine if Running in Debug Mode.vi

The launcher VI is meant to be run as a headless launcher for the module main VI. The launcher VI can be used as a debugging tool.

This VI determines if the launcher VI is running as a debugger by parsing the command line arguments or checking if the VI is running in development mode and sets the Launcher VI properties accordingly.

empty.png

empty.png

empty.png

Pre-Build Action

Launcher Support.lvlib:Pre-Build Action.vi

This Pre-Build Action VI sets the Debug mode to false to ensure the top level VI has the headless properties at build time.

empty.png

empty.png

empty.png

Set VI Properties for Debugging Mode

Launcher Support.lvlib:Set VI Properties for Debugging Mode.vi

This VI sets the properties of the VI Launcher to either headless or debugging mode.

empty.png

empty.png

empty.png

Scope: scope protected → Protected | scope community → Community

Reentrancy: reentrancy preallocated → Preallocated reentrancy | reentrancy shared → Shared reentrancy

Inlining: inlined → Inlined

4. Custom errors

Tip

Custom errors are added via vi named *--error.vi.

Table 31. Custom errors
Name Code Description Owned by

Module Not Running

403681

%s Module is not running.

CML UI.lvlib
Acquisition.lvlib
Logger.lvlib
Settings Editor.lvlib

Module Not Stopped

403682

The Stop Module VI for the %s module timed out while waiting for the module main VI to stop. The module main VI may still be running.

CML UI.lvlib
Acquisition.lvlib
Logger.lvlib
Settings Editor.lvlib

Module Not Synced

403683

%s Module was unable to synchronize events.

CML UI.lvlib
Acquisition.lvlib
Logger.lvlib
Settings Editor.lvlib

Request and Wait for Reply Timeout

403686

%s

CML UI.lvlib
Acquisition.lvlib
Logger.lvlib
Settings Editor.lvlib

5.1. Document creation

This document has been generated using the following tools.

5.1.1. Antidoc

Project website: Antidoc

Maintainer website: Wovalab

BSD 3-Clause License

Copyright © 2019, Wovalab, All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

  • Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

  • Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

  • Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

5.1.2. Asciidoc for LabVIEW™

Project website: Asciidoc toolkit

Maintainer website: Wovalab

BSD 3-Clause License

Copyright © 2019, Wovalab, All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

  • Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

  • Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

  • Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

5.1.3. Graph Builder

Project website: Graph Builder

BSD 3-Clause License

Copyright © 2020, Cyril GAMBINI All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

  • Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

  • Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

  • Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

5.2. Product used in the project

The documented project has been developed with the following products.

5.2.1. DQMH®

Copyright © 2021 DQMH® Consortium, LLC. All Rights Reserved.

Find more details on DQMH® Consortium website