DQMH API description :: DQMH Consortium Docs

Main palette

DQMH Create Message Queue

Delacor lib QMH Message Queue.lvclass Delacor lib QMH Create Message Queue.vi

This VI creates and initializes the message queue for a QMH Module. If the message needs to be different for the given module, then create a child class of Message Queue and override the appropriate methods.

DQMH Dequeue Message

Delacor lib QMH Message Queue.lvclass Delacor lib QMH Dequeue Message.vi

This VI pulls messages off the Message Queue.

DQMH Enqueue Message

Delacor lib QMH Message Queue.lvclass Delacor lib QMH Enqueue Message (poly).vi

This VI is polymorphic.

For a regular message, enqueue the message. For a priority message, enqueue it at the front of the queue.

DQMH Error Handler - MHL

Delacor lib QMH Message Queue.lvclass Delacor lib QMH Error Handler Message Handling Loop.vi

Process an error that occurred in the Message Handling Loop, either by ignoring it, or generating an "Error" message.

DQMH Error Handler - EHL

Delacor lib QMH Message Queue.lvclass Delacor lib QMH Error Handler Event Handling Loop.vi

Process an error that occurred in the Event Handling Loop, either by ignoring it, or generating an "Error" message.

DQMH Error Handler - Helper Loop

Delacor lib QMH Message Queue.lvclass Delacor lib QMH Error Handler Helper Loop.vi

Process an error that occurred in a Helper Loop, either by ignoring it, or generating an "Error" message.

DQMH Process Error Variant

Delacor lib QMH Message Queue.lvclass Delacor lib QMH Process Error Variant.vi

Property Node (DQMH Error Debug)

DQMH Flush Messages

Delacor lib QMH Message Queue.lvclass Delacor lib QMH Flush Messages.vi

Flush the message queue.

DQMH Release Message Queue

Delacor lib QMH Message Queue.lvclass Delacor lib QMH Release Message Queue.vi

Release the message queue.

About DQMH

When this VI executes, it pops up an "About" box with license information pertaining to DQMH.

DQMH Version Info

Returns DQMH version information.

DQMH Legal Info

Returns DQMH and LabVIEW legal information.

DQMH EULA URL

Returns the URL for the DQMH End User License Agreement (EULA).

ADMIN

DQMH Admin Object

Delacor lib QMH Module Admin.lvclass Delacor lib QMH Admin Class constant.vi

DQMH Cloneable Admin Object

Delacor lib QMH Cloneable Module Admin.lvclass Delacor lib QMH Cloneable Admin Class constant.vi

Reset Admin

Delacor lib QMH Module Admin.lvclass Delacor lib QMH Reset.vi

DQMH Scripting

Get DQMH Modules in Project

Returns library references for all detected DQMH modules in a project. Remember to close the library references when you are done using them.

Note that this VI will not return DQMH modules that are inside PPLs.

Get Event VIs in DQMH Module

Returns VI references to all event VIs in a given DQMH module, separated by event type. Remember to close the VI references when you are done using them.

Get Callers of Request VI in Project

Returns VI references to all VIs in the project that call the given request VI. Remember to close the VI references when you are done using them.

Get VIs Registered for Broadcast in Project

Returns VI references to all VIs in the project that contain an event structure registered for the broadcast event of the given broadcast VI. Remember to close the VI references when you are done using them.

Note that since this VI parses the diagrams of all VIs in the project, it may take a while to complete.

Validate All DQMH Modules in Project

Pass this VI a project reference and it will validate all DQMH Modules in that project. Possible return values of this VI are:

ERROR: [description of error that occurred when trying to validate]

PASS: [n] Modules Validated

FAIL: [n] Modules Analyzed

…

Obtain Progress Events

Return event references to monitor the progress of DQMH validation. Use in conjunction with the 'Validate All DQMH Modules in Project.vi'.

See the 'Headless Validation Example.vi' for an illustration of how to use this VI to monitor validation progress.