nScopeAPI
v0.8
|
contains function headers for controlling the nScope analog inputs More...
Functions | |
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. More... | |
NSCOPE_API ErrorType | nScope_get_channels_on (ScopeHandle nScope, bool *channelsOn) |
Get the channel states (on/off) for all channels. More... | |
NSCOPE_API ErrorType | nScope_get_num_channels_on (ScopeHandle nScope, int *numChannelsOn) |
Get the number of channels currently on. More... | |
NSCOPE_API ErrorType | nScope_set_ChX_on (ScopeHandle nScope, int ch, bool channelOn) |
Set a channel state on or off. More... | |
NSCOPE_API ErrorType | nScope_get_ChX_on (ScopeHandle nScope, int ch, bool *channelOn) |
Get the on/off state of a given channel. More... | |
NSCOPE_API ErrorType | nScope_set_channel_gains (ScopeHandle nScope, double ch1Gain, double ch2Gain, double ch3Gain, double ch4Gain) |
Set the channel gains for all channels. More... | |
NSCOPE_API ErrorType | nScope_get_channel_gains (ScopeHandle nScope, double *channelGains) |
Get the channel gains for all channels. More... | |
NSCOPE_API ErrorType | nScope_set_ChX_gain (ScopeHandle nScope, int ch, double channelGain) |
Set a given channel's gain. More... | |
NSCOPE_API ErrorType | nScope_get_ChX_gain (ScopeHandle nScope, int ch, double *channelGain) |
Get the gain of a given channel. More... | |
NSCOPE_API ErrorType | nScope_set_channel_levels (ScopeHandle nScope, double ch1Level, double ch2Level, double ch3Level, double ch4Level) |
Set the channel levels for all channels. More... | |
NSCOPE_API ErrorType | nScope_get_channel_levels (ScopeHandle nScope, double *channelLevels) |
Get the channel levels for all channels. More... | |
NSCOPE_API ErrorType | nScope_set_ChX_level (ScopeHandle nScope, int ch, double channelLevel) |
Set a given channel's level. More... | |
NSCOPE_API ErrorType | nScope_get_ChX_level (ScopeHandle nScope, int ch, double *channelLevel) |
Get the level of a given channel. More... | |
contains function headers for controlling the nScope analog inputs
NSCOPE_API ErrorType nScope_get_channel_gains | ( | ScopeHandle | nScope, |
double * | channelGains | ||
) |
Get the channel gains for all channels.
[in] | nScope | ScopeHandle object |
[out] | channelGains | pointer to an array of doubles for retreiving the gain for each channel |
NSCOPE_API ErrorType nScope_get_channel_levels | ( | ScopeHandle | nScope, |
double * | channelLevels | ||
) |
Get the channel levels for all channels.
[in] | nScope | ScopeHandle object |
[out] | channelLevels | pointer to an array of doubles for retreiving the level for each channel |
NSCOPE_API ErrorType nScope_get_channels_on | ( | ScopeHandle | nScope, |
bool * | channelsOn | ||
) |
Get the channel states (on/off) for all channels.
A true state means the channel is on and will sample if a request is sent
[in] | nScope | pointer to nScope handle |
[out] | channelsOn | pointer to an array of booleans for retreiving the on state for each channel |
NSCOPE_API ErrorType nScope_get_ChX_gain | ( | ScopeHandle | nScope, |
int | ch, | ||
double * | channelGain | ||
) |
Get the gain of a given channel.
[in] | nScope | ScopeHandle object |
[in] | ch | channel number to query |
[out] | channelGain | pointer to double to store the channel gain |
NSCOPE_API ErrorType nScope_get_ChX_level | ( | ScopeHandle | nScope, |
int | ch, | ||
double * | channelLevel | ||
) |
Get the level of a given channel.
[in] | nScope | ScopeHandle object |
[in] | ch | channel number to query |
[out] | channelLevel | pointer to double to store the channel level |
NSCOPE_API ErrorType nScope_get_ChX_on | ( | ScopeHandle | nScope, |
int | ch, | ||
bool * | channelOn | ||
) |
Get the on/off state of a given channel.
[in] | nScope | ScopeHandle object |
[in] | ch | channel number to query |
[out] | channelOn | pointer to bool to store whether the channel is on or off |
NSCOPE_API ErrorType nScope_get_num_channels_on | ( | ScopeHandle | nScope, |
int * | numChannelsOn | ||
) |
Get the number of channels currently on.
[in] | nScope | ScopeHandle |
[out] | numChannelsOn | pointer to a variable for retreiving the number of channels on |
NSCOPE_API ErrorType nScope_set_channel_gains | ( | ScopeHandle | nScope, |
double | ch1Gain, | ||
double | ch2Gain, | ||
double | ch3Gain, | ||
double | ch4Gain | ||
) |
Set the channel gains for all channels.
A gain of 1 indicates
[in] | nScope | ScopeHandle object |
[in] | ch1Gain | channel 1 gain |
[in] | ch2Gain | channel 2 gain |
[in] | ch3Gain | channel 3 gain |
[in] | ch4Gain | channel 4 gain |
NSCOPE_API ErrorType nScope_set_channel_levels | ( | ScopeHandle | nScope, |
double | ch1Level, | ||
double | ch2Level, | ||
double | ch3Level, | ||
double | ch4Level | ||
) |
Set the channel levels for all channels.
Level means:
[in] | nScope | ScopeHandle object |
[in] | ch1Level | channel 1 level |
[in] | ch2Level | channel 2 level |
[in] | ch3Level | channel 3 level |
[in] | ch4Level | channel 4 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.
A true state means the channel is on and will sample if a request is sent
[in] | nScope | nScope handle |
[in] | ch1on | true: turn channel 1 on, false: turn it off |
[in] | ch2on | true: turn channel 2 on, false: turn it off |
[in] | ch3on | true: turn channel 3 on, false: turn it off |
[in] | ch4on | true: turn channel 4 on, false: turn it off |
NSCOPE_API ErrorType nScope_set_ChX_gain | ( | ScopeHandle | nScope, |
int | ch, | ||
double | channelGain | ||
) |
Set a given channel's gain.
[in] | nScope | ScopeHandle object |
[in] | ch | channel number to set on or off |
[in] | channelGain | the desired gain of the channel |
NSCOPE_API ErrorType nScope_set_ChX_level | ( | ScopeHandle | nScope, |
int | ch, | ||
double | channelLevel | ||
) |
Set a given channel's level.
[in] | nScope | ScopeHandle object |
[in] | ch | channel number to set on or off |
[out] | channelLevel | the desired level of the channel |
NSCOPE_API ErrorType nScope_set_ChX_on | ( | ScopeHandle | nScope, |
int | ch, | ||
bool | channelOn | ||
) |
Set a channel state on or off.
A true state means the channel is on and will sample if a request is sent
[in] | nScope | ScopeHandle object |
[in] | ch | channel number to set on or off |
[in] | channelOn | true: turn the channel on, false: turn the channel off |