Table of Contents
hil_write_other_buffer
Writes the specified number of samples to the other channels at the indicated sampling rate.
Description
The hil_write_other_buffer function writes the specified number of samples to the other output channels at the given sampling rate. The function does not return until the data has been written.
Prototype
t_error hil_write_other_buffer(t_card card, t_clock clock, t_double frequency, t_uint32 num_samples, const t_uint32 other_channels[], t_uint32 num_channels, const t_double buffer[]);
Parameters
t_card card
A handle to the board, as returned by hil_open .
t_clock clock
The clock used to time the operation. Note that some clocks allow faster sampling rates than others. See Clocks for more information on clocks.
Select a board type from the list for board-specific details: .
t_double frequency
The frequency in Hertz at which to write to the other output channels. For example, if frequency is set to 1000, then the hil_write_other_buffer function will write to all the selected channels every millisecond.
t_uint32 num_samples
The number of samples to generate. Each "sample" consists of all the other output channels specified. For example, if frequency is set to 1000 and num_samples is set to 5000, then the hil_write_other_buffer function will return after 5 seconds, having written 5000 samples. If 3 channels have been selected, then the buffer must therefore contain 15,000 elements.
const t_uint32 [] other_channels
An array containing the channel numbers of the other outputs to which to write.
Select a board type from the list for board-specific details: .
t_uint32 num_channels
The number of channels specified in the other_channels array.
const t_double [] buffer
An array containing the values to write to the other outputs. The array must contain num_channels * num_samples elements. The array must be organized as a linear array of samples, with each sample consisting of a group of channels. For example, if other output channels 0, 1 and 3 are being written, than the data must appear in the array as follows, where the numbers correspond to channel numbers:
0 |
1 |
3 |
0 |
1 |
3 |
... |
This ordering is equivalent to defining the buffer as:
t_double buffer[num_samples][num_channels];
If the buffer is defined this way then pass the buffer as the
buffer argument using the syntax:
&buffer[0][0]
.
Return value
The return value is the number of samples successfully written. Otherwise
a negative error code is returned. Error codes
are defined in quanser_errors.h
. A suitable error
message may be retrieved using
msg_get_error_message
.
Error codes
QERR_HIL_WRITE_OTHER_BUFFER_NOT_SUPPORTED
This function is not supported by the board-specific HIL driver for this board type.
QERR_INVALID_CARD_HANDLE
An invalid card handle was passed as an argument. Once a card has been closed using hil_close the card handle is invalid.
QERR_MISSING_OTHER_OUTPUTS
The other_channels argument is NULL. If the number of channels is greater than zero then a channel vector must be provided.
QERR_MISSING_OTHER_OUTPUT_BUFFER
The buffer argument is NULL. If the number of channels is greater than zero then a buffer must be provided.
QERR_TOO_MANY_OTHER_OUTPUT_CHANNELS
Too many other output channels were specified.
QERR_INVALID_OTHER_OUTPUT_CHANNEL
One of the other output channels that was specified is not a valid channel number. Channel numbers range from 0 to one less than the number of channels.
QERR_DRIVER_INCOMPATIBLE_WITH_BOARD_DLL
The board-specific HIL driver passed an invalid parameter to the operating system specific kernel-level driver for the board. The board-specific HIL driver is likely not compatible with the operating system specific kernel-level driver for the board. Make sure both are up-to-date and compatible versions.
QERR_INTERNAL_BUFFER_TOO_SMALL
The board-specific HIL driver used an internal buffer that was too small for the operating system specific kernel-level driver for the board. The board-specific HIL driver is likely not compatible with the operating system specific kernel-level driver for the board. Make sure both are up-to-date and compatible versions.
QERR_OUT_OF_REQUIRED_SYSTEM_RESOURCES
There are not enough system resources to perform the requested operation. Try rebooting, requesting fewer samples, or adding more memory to your machine.
QERR_OUT_OF_MEMORY
There is not enough memory to perform the operation.
Requirements
Include Files |
Libraries |
---|---|
hil.h |
hil.lib;quanser_runtime.lib;quanser_common.lib |
Examples
/* * Writes 5000 samples at 1 kHz to the first four other output channels, using SYSTEM_CLOCK_1. * 1 Hz sine waves are written to the outputs. */ t_uint32 channels[] = { 0, 1, 2, 3 }; t_double frequency = 1000; t_uint32 samples = 5000; t_error result; int i, j; static t_double buffer[5000][4]; for (i=0; i < samples; i++) { double time = i / frequency; for (j=0; j < ARRAY_LENGTH(channels); j++) buffer[i][j] = (j + 7.0) * sin(2*M_PI*time); } result = hil_write_other_buffer(board, SYSTEM_CLOCK_1, frequency, samples, channels, ARRAY_LENGTH(channels), &buffer[0][0]);
Copyright ©2024 Quanser Inc. This page was generated 2024-10-17. Submit feedback to Quanser about this page.
Link to this page.