nScopeAPI  v0.8
nScopeAPI_pulseGenerators.h
Go to the documentation of this file.
1 /*******************************************************
2  nScopeAPI - Multi-Platform library for
3  communication with nScope devices.
4 
5  David Meyer
6 
7  10/23/2014
8 
9  Copyright 2014, All Rights Reserved.
10 
11 ********************************************************/
12 
23 #ifndef NSCOPEAPI_PULSEGNERATORS_H__
24 #define NSCOPEAPI_PULSEGNERATORS_H__
25 
26 
27 
28 #ifdef __cplusplus
29 extern "C" {
30 #endif
31 
46  NSCOPE_API ErrorType nScope_set_PX_on(ScopeHandle nScope, int pChannel, bool PXon);
47 
59  NSCOPE_API ErrorType nScope_get_PX_on(ScopeHandle nScope, int pChannel, bool* PXon);
60 
75  NSCOPE_API ErrorType nScope_set_P1_P2_on(ScopeHandle nScope, bool P1on, bool P2on);
76 
89  NSCOPE_API ErrorType nScope_get_P1_P2_on(ScopeHandle nScope, bool* pulseGensOn);
90 
104  NSCOPE_API ErrorType nScope_set_PX_frequency_in_hz(ScopeHandle nScope, int pChannel, double frequency);
105 
117  NSCOPE_API ErrorType nScope_get_PX_frequency_in_hz(ScopeHandle nScope, int pChannel, double* frequency);
118 
132  NSCOPE_API ErrorType nScope_set_P1_P2_frequencies_in_hz(ScopeHandle nScope, double frequency1, double frequency2);
133 
143  NSCOPE_API ErrorType nScope_get_P1_P2_frequencies_in_hz(ScopeHandle nScope, double* pulseFrequencies);
144 
160  NSCOPE_API ErrorType nScope_set_PX_period_in_ms(ScopeHandle nScope, int pChannel, double period);
161 
175  NSCOPE_API ErrorType nScope_get_PX_period_in_ms(ScopeHandle nScope, int pChannel, double* period);
176 
192  NSCOPE_API ErrorType nScope_set_P1_P2_periods_in_ms(ScopeHandle nScope, double period1, double period2);
193 
205  NSCOPE_API ErrorType nScope_get_P1_P2_periods_in_ms(ScopeHandle nScope, double* pulsePeriods);
206 
222  NSCOPE_API ErrorType nScope_set_PX_period_in_us(ScopeHandle nScope, int pChannel, double period);
223 
237  NSCOPE_API ErrorType nScope_get_PX_period_in_us(ScopeHandle nScope, int pChannel, double* period);
238 
254  NSCOPE_API ErrorType nScope_set_P1_P2_periods_in_us(ScopeHandle nScope, double period1, double period2);
255 
267  NSCOPE_API ErrorType nScope_get_P1_P2_periods_in_us(ScopeHandle nScope, double* pulsePeriods);
268 
285  NSCOPE_API ErrorType nScope_set_PX_duty_percentage(ScopeHandle nScope, int pChannel, double duty);
286 
301  NSCOPE_API ErrorType nScope_get_PX_duty_percentage(ScopeHandle nScope, int pChannel, double* duty);
302 
319  NSCOPE_API ErrorType nScope_set_P1_P2_duty_percentages(ScopeHandle nScope, double duty1, double duty2);
320 
333  NSCOPE_API ErrorType nScope_get_P1_P2_duty_percentages(ScopeHandle nScope, double* dutyPercentages);
334 
350  NSCOPE_API ErrorType nScope_set_PX_pulse_width_in_ms(ScopeHandle nScope, int pChannel, double pulseWidth);
351 
365  NSCOPE_API ErrorType nScope_get_PX_pulse_width_in_ms(ScopeHandle nScope, int pChannel, double* pulseWidth);
366 
382  NSCOPE_API ErrorType nScope_set_P1_P2_pulse_widths_in_ms(ScopeHandle nScope, double pulseWidth1, double pulseWidth2);
383 
395  NSCOPE_API ErrorType nScope_get_P1_P2_pulse_widths_in_ms(ScopeHandle nScope, double* pulseWidths);
396 
412  NSCOPE_API ErrorType nScope_set_PX_pulse_width_in_us(ScopeHandle nScope, int pChannel, double pulseWidth);
413 
427  NSCOPE_API ErrorType nScope_get_PX_pulse_width_in_us(ScopeHandle nScope, int pChannel, double* pulseWidth);
428 
444  NSCOPE_API ErrorType nScope_set_P1_P2_pulse_widths_in_us(ScopeHandle nScope, double pulseWidth1, double pulseWidth2);
445 
457  NSCOPE_API ErrorType nScope_get_P1_P2_pulse_widths_in_us(ScopeHandle nScope, double* pulseWidths);
458 
474  NSCOPE_API ErrorType nScope_send_PX_oneshot_pulse(ScopeHandle nScope, int pChannel, double pulseWidth);
475 
491  NSCOPE_API ErrorType nScope_send_P1_P2_oneshot_pulses(ScopeHandle nScope, double pulseWidth1, double pulseWidth2);
492 
493 
494 
495 #ifdef __cplusplus
496 }
497 #endif
498 
499 #endif
nScope_set_PX_period_in_ms
NSCOPE_API ErrorType nScope_set_PX_period_in_ms(ScopeHandle nScope, int pChannel, double period)
Set a pulse channel period in milliseconds.
nScope_get_PX_duty_percentage
NSCOPE_API ErrorType nScope_get_PX_duty_percentage(ScopeHandle nScope, int pChannel, double *duty)
Get a pulse channel duty percentage.
NSCOPE_API
#define NSCOPE_API
Definition: nScopeAPI_defs.h:29
nScope_set_P1_P2_frequencies_in_hz
NSCOPE_API ErrorType nScope_set_P1_P2_frequencies_in_hz(ScopeHandle nScope, double frequency1, double frequency2)
Set the pulse channel frequencies in hz.
nScope_set_P1_P2_periods_in_us
NSCOPE_API ErrorType nScope_set_P1_P2_periods_in_us(ScopeHandle nScope, double period1, double period2)
Set a pulse channel periods in microseconds.
nScope_get_P1_P2_periods_in_us
NSCOPE_API ErrorType nScope_get_P1_P2_periods_in_us(ScopeHandle nScope, double *pulsePeriods)
Get a pulse channel periods in microseconds.
nScope_get_PX_pulse_width_in_ms
NSCOPE_API ErrorType nScope_get_PX_pulse_width_in_ms(ScopeHandle nScope, int pChannel, double *pulseWidth)
Get a pulse width in milliseconds on a pulse channel.
nScope_send_PX_oneshot_pulse
NSCOPE_API ErrorType nScope_send_PX_oneshot_pulse(ScopeHandle nScope, int pChannel, double pulseWidth)
Send a single pulse out on a pulse channel.
nScope_get_PX_period_in_ms
NSCOPE_API ErrorType nScope_get_PX_period_in_ms(ScopeHandle nScope, int pChannel, double *period)
Get a pulse channel period in milliseconds.
ErrorType
ErrorType
Definition: nScopeAPI_defs.h:42
nScope_set_PX_pulse_width_in_ms
NSCOPE_API ErrorType nScope_set_PX_pulse_width_in_ms(ScopeHandle nScope, int pChannel, double pulseWidth)
Set a pulse width in milliseconds on a pulse channel.
nScope_get_P1_P2_frequencies_in_hz
NSCOPE_API ErrorType nScope_get_P1_P2_frequencies_in_hz(ScopeHandle nScope, double *pulseFrequencies)
Get the pulse channel frequencies in hz.
nScope_send_P1_P2_oneshot_pulses
NSCOPE_API ErrorType nScope_send_P1_P2_oneshot_pulses(ScopeHandle nScope, double pulseWidth1, double pulseWidth2)
Send a single pulse out on both pulse channels.
nScope_set_PX_frequency_in_hz
NSCOPE_API ErrorType nScope_set_PX_frequency_in_hz(ScopeHandle nScope, int pChannel, double frequency)
Set a pulse channel frequency in hz.
nScope_set_PX_pulse_width_in_us
NSCOPE_API ErrorType nScope_set_PX_pulse_width_in_us(ScopeHandle nScope, int pChannel, double pulseWidth)
Set a pulse width in microseconds on a pulse channel.
nScope_set_PX_duty_percentage
NSCOPE_API ErrorType nScope_set_PX_duty_percentage(ScopeHandle nScope, int pChannel, double duty)
Set a pulse channel duty percentage.
nScope_get_P1_P2_periods_in_ms
NSCOPE_API ErrorType nScope_get_P1_P2_periods_in_ms(ScopeHandle nScope, double *pulsePeriods)
Get a pulse channel periods in milliseconds.
nScope_get_P1_P2_pulse_widths_in_ms
NSCOPE_API ErrorType nScope_get_P1_P2_pulse_widths_in_ms(ScopeHandle nScope, double *pulseWidths)
Get the pulse widths in milliseconds on the pulse channels.
nScope_get_PX_pulse_width_in_us
NSCOPE_API ErrorType nScope_get_PX_pulse_width_in_us(ScopeHandle nScope, int pChannel, double *pulseWidth)
Get a pulse width in microseconds on a pulse channel.
nScope_get_PX_frequency_in_hz
NSCOPE_API ErrorType nScope_get_PX_frequency_in_hz(ScopeHandle nScope, int pChannel, double *frequency)
Get a pulse channel frequency in hz.
nScope_set_P1_P2_periods_in_ms
NSCOPE_API ErrorType nScope_set_P1_P2_periods_in_ms(ScopeHandle nScope, double period1, double period2)
Set a pulse channel periods in milliseconds.
nScope_get_PX_period_in_us
NSCOPE_API ErrorType nScope_get_PX_period_in_us(ScopeHandle nScope, int pChannel, double *period)
Get a pulse channel period in microseconds.
nScope_get_P1_P2_pulse_widths_in_us
NSCOPE_API ErrorType nScope_get_P1_P2_pulse_widths_in_us(ScopeHandle nScope, double *pulseWidths)
Get the pulse widths in microseconds on the pulse channels.
nScope_set_PX_period_in_us
NSCOPE_API ErrorType nScope_set_PX_period_in_us(ScopeHandle nScope, int pChannel, double period)
Set a pulse channel period in microseconds.
ScopeHandle
struct scopeDev_ * ScopeHandle
Definition: nScopeAPI_defs.h:32
nScope_set_P1_P2_on
NSCOPE_API ErrorType nScope_set_P1_P2_on(ScopeHandle nScope, bool P1on, bool P2on)
Set the pulse channels (on/off)
nScope_set_P1_P2_pulse_widths_in_us
NSCOPE_API ErrorType nScope_set_P1_P2_pulse_widths_in_us(ScopeHandle nScope, double pulseWidth1, double pulseWidth2)
Set the pulse widths in microseconds on the pulse channels.
nScope_get_P1_P2_on
NSCOPE_API ErrorType nScope_get_P1_P2_on(ScopeHandle nScope, bool *pulseGensOn)
Get the pulse channels (on/off)
nScope_set_P1_P2_duty_percentages
NSCOPE_API ErrorType nScope_set_P1_P2_duty_percentages(ScopeHandle nScope, double duty1, double duty2)
Set the pulse channel duty percentages.
nScope_get_PX_on
NSCOPE_API ErrorType nScope_get_PX_on(ScopeHandle nScope, int pChannel, bool *PXon)
Get a pulse channel (on/off)
nScope_set_PX_on
NSCOPE_API ErrorType nScope_set_PX_on(ScopeHandle nScope, int pChannel, bool PXon)
Set a pulse channel (on/off)
nScope_set_P1_P2_pulse_widths_in_ms
NSCOPE_API ErrorType nScope_set_P1_P2_pulse_widths_in_ms(ScopeHandle nScope, double pulseWidth1, double pulseWidth2)
Set the pulse widths in milliseconds on the pulse channels.
nScope_get_P1_P2_duty_percentages
NSCOPE_API ErrorType nScope_get_P1_P2_duty_percentages(ScopeHandle nScope, double *dutyPercentages)
Get the pulse channel duty percentages.
Generated on Sun Jun 24 2018 18:09:01 for nScopeAPI by doxygen 1.8.11