nScopeAPI  v0.8
nScopeAPI_analogInputs.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 
18 #ifndef NSCOPEAPI_ANALOGINPUTS_H__
19 #define NSCOPEAPI_ANALOGINPUTS_H__
20 
21 
22 
23 #ifdef __cplusplus
24 extern "C" {
25 #endif
26 
44  NSCOPE_API ErrorType nScope_set_channels_on(ScopeHandle nScope, bool ch1on, bool ch2on, bool ch3on, bool ch4on);
45 
57  NSCOPE_API ErrorType nScope_get_channels_on(ScopeHandle nScope, bool* channelsOn);
58 
68  NSCOPE_API ErrorType nScope_get_num_channels_on(ScopeHandle nScope, int* numChannelsOn);
69 
83  NSCOPE_API ErrorType nScope_set_ChX_on(ScopeHandle nScope, int ch, bool channelOn);
84 
96  NSCOPE_API ErrorType nScope_get_ChX_on(ScopeHandle nScope, int ch, bool* channelOn);
97 
115  NSCOPE_API ErrorType nScope_set_channel_gains(ScopeHandle nScope, double ch1Gain, double ch2Gain, double ch3Gain, double ch4Gain);
116 
126  NSCOPE_API ErrorType nScope_get_channel_gains(ScopeHandle nScope, double* channelGains);
127 
139  NSCOPE_API ErrorType nScope_set_ChX_gain(ScopeHandle nScope, int ch, double channelGain);
140 
152  NSCOPE_API ErrorType nScope_get_ChX_gain(ScopeHandle nScope, int ch, double* channelGain);
153 
171  NSCOPE_API ErrorType nScope_set_channel_levels(ScopeHandle nScope, double ch1Level, double ch2Level, double ch3Level, double ch4Level);
172 
182  NSCOPE_API ErrorType nScope_get_channel_levels(ScopeHandle nScope, double* channelLevels);
183 
195  NSCOPE_API ErrorType nScope_set_ChX_level(ScopeHandle nScope, int ch, double channelLevel);
196 
208  NSCOPE_API ErrorType nScope_get_ChX_level(ScopeHandle nScope, int ch, double* channelLevel);
209 
210 
211 #ifdef __cplusplus
212 }
213 #endif
214 
215 #endif
#define NSCOPE_API
Definition: nScopeAPI_defs.h:29
NSCOPE_API ErrorType nScope_get_num_channels_on(ScopeHandle nScope, int *numChannelsOn)
Get the number of channels currently on.
NSCOPE_API ErrorType nScope_set_ChX_on(ScopeHandle nScope, int ch, bool channelOn)
Set a channel state on or off.
ErrorType
Definition: nScopeAPI_defs.h:42
NSCOPE_API ErrorType nScope_set_channel_levels(ScopeHandle nScope, double ch1Level, double ch2Level, double ch3Level, double ch4Level)
Set the channel levels for all channels.
NSCOPE_API ErrorType nScope_get_channel_gains(ScopeHandle nScope, double *channelGains)
Get the channel gains for all channels.
NSCOPE_API ErrorType nScope_set_channel_gains(ScopeHandle nScope, double ch1Gain, double ch2Gain, double ch3Gain, double ch4Gain)
Set the channel gains for all channels.
NSCOPE_API ErrorType nScope_get_ChX_on(ScopeHandle nScope, int ch, bool *channelOn)
Get the on/off state of a given channel.
NSCOPE_API ErrorType nScope_set_ChX_gain(ScopeHandle nScope, int ch, double channelGain)
Set a given channel's gain.
NSCOPE_API ErrorType nScope_get_channels_on(ScopeHandle nScope, bool *channelsOn)
Get the channel states (on/off) for all channels.
struct scopeDev_ * ScopeHandle
Definition: nScopeAPI_defs.h:32
NSCOPE_API ErrorType nScope_set_ChX_level(ScopeHandle nScope, int ch, double channelLevel)
Set a given channel's level.
NSCOPE_API ErrorType nScope_set_channels_on(ScopeHandle nScope, bool ch1on, bool ch2on, bool ch3on, bool ch4on)
Set the channel states (on/off) for all channels.
NSCOPE_API ErrorType nScope_get_ChX_gain(ScopeHandle nScope, int ch, double *channelGain)
Get the gain of a given channel.
NSCOPE_API ErrorType nScope_get_ChX_level(ScopeHandle nScope, int ch, double *channelLevel)
Get the level of a given channel.
NSCOPE_API ErrorType nScope_get_channel_levels(ScopeHandle nScope, double *channelLevels)
Get the channel levels for all channels.