nScopeAPI  v0.8
nScopeAPI_requests.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_REQUESTS_H__
19 #define NSCOPEAPI_REQUESTS_H__
20 
21 
22 #ifdef __cplusplus
23 extern "C" {
24 #endif
25 
43  NSCOPE_API ErrorType nScope_request_data(ScopeHandle nScope, Request* newRequest_p, int numSamples, bool antiAliased);
44 
51 
64 
82 
95 
110  NSCOPE_API ErrorType nScope_request_xfer_has_completed(ScopeHandle nScope, Request reqHandle, bool* hasCompleted);
111 
118 
125 
141  NSCOPE_API ErrorType nScope_read_data(ScopeHandle nScope, Request reqHandle, int channel, double* data);
142 
157  NSCOPE_API ErrorType nScope_request_has_data(ScopeHandle nScope, Request reqHandle, bool* hasData);
158 
159 #ifdef __cplusplus
160 }
161 #endif
162 
163 
164 #endif
#define NSCOPE_API
Definition: nScopeAPI_defs.h:29
NSCOPE_API ErrorType nScope_request_xfer_samples_remaining(ScopeHandle nScope, Request reqHandle)
query the number of samples remaining in the request transfer
NSCOPE_API ErrorType nScope_request_data_stream(ScopeHandle nScope, Request *newRequest_p)
Request an infinite stream of data from nScope.
NSCOPE_API ErrorType nScope_stop_request(ScopeHandle nScope, Request reqHandle)
stop a request that is in progress
ErrorType
Definition: nScopeAPI_defs.h:42
NSCOPE_API ErrorType nScope_request_has_data(ScopeHandle nScope, Request reqHandle, bool *hasData)
determine if a request has unread data still stored in it
NSCOPE_API ErrorType nScope_request_data(ScopeHandle nScope, Request *newRequest_p, int numSamples, bool antiAliased)
Request data from nScope.
NSCOPE_API ErrorType nScope_request_xfer_has_completed(ScopeHandle nScope, Request reqHandle, bool *hasCompleted)
determine if a request has completed the transfer
struct scopeDev_ * ScopeHandle
Definition: nScopeAPI_defs.h:32
NSCOPE_API ErrorType nScope_release_request(ScopeHandle nScope, Request *reqHandle_p)
release a request that is finished or stopped
NSCOPE_API ErrorType nScope_wait_for_request_finish(ScopeHandle nScope, Request reqHandle)
wait for a request to finish
NSCOPE_API ErrorType nScope_read_data(ScopeHandle nScope, Request reqHandle, int channel, double *data)
Read data from the request.
struct request_ * Request
Definition: nScopeAPI_defs.h:35
NSCOPE_API ErrorType nScope_stop_data_stream(ScopeHandle nScope, Request reqHandle)
Stop an infinite stream of data from nScope.