HIL Task Get Board

Owning Palette: HIL/Core/Task

Requirements: Quanser Rapid Control Prototyping Toolkit, LabVIEW 2020 or newer

Description

Get the corresponding HIL board from the HIL Task.

Required Inputs All required inputs must be wired. They appear in bold text in the context help window for the VI.

task in is a reference to a HIL Task instance that represents the HIL task that we want to get the owning HIL board. This input must be wired to a valid HIL Task signal, as generated by a HIL Task Create Reader VI.

Recommended Inputs Recommended inputs need not be wired. They appear as simple text in the context help window for the VI.

error in describes error conditions occurring before the VI executes. If an error has already occurred, the VI returns the value of the error in cluster in error out.

status is TRUE if an error occurred. If status is TRUE, the VI does not perform any operations.

code is the error code number identifying an error. A value of 0 means no error, a negative value means a fatal error, and a positive value is a warning. Refer to the Quanser Error Codes for a code description.

source identifies where an error occurred. The source string is usually the name of the VI that produced the error.

Outputs

board out is a reference to the HIL Board instance owns the HIL Task. This output can be used on any VI that requires a valid HIL Board reference..

error out contains error information. If the error in cluster indicated an error, the error out cluster contains the same information. Otherwise, error out describes the error status of this VI.

	status is TRUE if an error occurred. If status is TRUE, the VI does not perform any operations.
	code is the error code number identifying an error. A value of 0 means no error, a negative value means a fatal error, and a positive value is a warning. Refer to the Quanser Error Codes for a code description.
	source identifies where an error occurred. The source string is usually the name of the VI that produced the error.

Details

Typical usage of HIL Task is to create a task using HIL Task Create Reader VI. This task is used to read the input channels, then logic can be applied to the inputs, and the corresponding outputs are then commanded to the outputs via HIL Write VI, which requires a HIL Board reference. This VI can be used to provide the HIL Board from the HIL Task.

Feedthrough Behaviour

All input/output pairs of this function have direct feedthrough behaviour.

Examples

There are currently no examples

Targets

Target	Supported	Comments
RCP Windows (64-bit) Target	Yes	Fully supported.

navigation bar

	HIL Task Create Reader	Create a task for reading from analog, digital, encoder and/or other channels of a HIL board. The task allows other operations to be performed while the inputs are being read "in the background". The data is read into an internal circular "task buffer" from which it can be read at any time using the HIL Task Read VI. The size of this task buffer is determined by the sample in buffer input.
	HIL Initialize	Initializes a hardware-in-the-loop (HIL) card for use with the other HIL VIs or CL HIL Control & Simulation Loop VIs.