Main Page | Namespace List | Class Hierarchy | Data Structures | File List | Data Fields | Globals | Related Pages

acq2xx.h File Reference

ACQ2xx web service definition. More...

Go to the source code of this file.

Data Structures

class  acq2xx__Object
 generic top level Object. More...
class  acq2xx__Transaction
 generic command/response remote transaction with status. More...
class  acq2xx__TransactionList
 container. More...
class  acq2xx__ShellTransaction
 remote shell transaction More...
struct  acq2xx__AcqStatus
 reports capture state main parameters. More...
struct  acq2xx__Signal
 aggregate holds full signal definition. More...
class  acq2xx__ModeSetTransaction
 sets capture mode, prelen, postlen More...
class  acq2xx__ClockSetTransaction
class  acq2xx__InternalClockSetTransaction
 configures internal clock. More...
class  acq2xx__ExternalClockSetTransaction
 configures external clock signal. More...
class  acq2xx__SignalSetTransaction
 generic signal setting transaction. More...
class  acq2xx__AcqControlTransaction
 sets main parameters to define a shot. More...
class  acq2xx__GetAvailableChannelsTransaction
class  acq2xx__GetVRangeTransaction
 returns current calibration settings More...
struct  acq2xx__GetVRangeTransaction::VRange
 single channel calibration range More...
struct  acq2xx__GetVRangeTransaction::VRangeData

Enumerations

enum  STATE {
  ST_STOP, ST_ARM, ST_RUN, ST_TRIGGER,
  ST_POSTPROCESS, ST_CAPDONE
}
 process states. More...
enum  acq2xx__EDGE { EDGE_FALLING, EDGE_RISING }
 input signal edge control. More...
enum  acq2xx__DIx {
  DI_NONE, DI0, DI1, DI2,
  DI3, DI4, DI5
}
 input signal line select. More...
enum  acq2xx__DOx {
  DO_NONE, DO0, DO1, DO2,
  DO3, DO4, DO5
}
 output signal line select. More...
enum  acq2xx__MODE { MODE_SOFT_TRANSIENT, MODE_TRIGGERED_CONTINUOUS, MODE_GATED_TRANSIENT, MODE_SOFT_CONTINUOUS }
 capture modes. More...

Functions

int acq2xx__getVersion (char *client_version, char *&server_version)
 version check - allows client, server to compare ACQ2XX_H_VERSION
int acq2xx__acqcmd (char *command, char *&response)
 remote "acqcmd"
int acq2xx__acq2sh (char *command, char *&response)
 remote shell command.
int acq2xx__acq2script (acq2xx__Transaction *in, struct acq2xx__acq2scriptResponse{acq2xx__Transaction *out;}&result)
 run a script comprising a single Transaction Object, where the Transaction Object may itself be a list on transactions.
int acq2xx__getAcqStatus (struct acq2xx__AcqStatus &status)
 output capture state main parameters.
int acq2xx__setArm (int block=false, struct acq2xx__AcqStatus &status)
 starts a capture.
int acq2xx__waitStop (int timeout_sec, struct acq2xx__AcqStatus &status)
 wait until stopped, up until timeout (min=1s, max=10s).


Detailed Description

ACQ2xx web service definition.

Definition in file acq2xx.h.


Enumeration Type Documentation

enum acq2xx__DIx
 

input signal line select.

Enumerator:
DI_NONE 
DI0 
DI1 
DI2 
DI3 
DI4 
DI5 

Definition at line 247 of file acq2xx.h.

enum acq2xx__DOx
 

output signal line select.

Enumerator:
DO_NONE 
DO0 
DO1 
DO2 
DO3 
DO4 
DO5 

Definition at line 252 of file acq2xx.h.

enum acq2xx__EDGE
 

input signal edge control.

Enumerator:
EDGE_FALLING 
EDGE_RISING 

Definition at line 243 of file acq2xx.h.

enum acq2xx__MODE
 

capture modes.

Enumerator:
MODE_SOFT_TRANSIENT 
MODE_TRIGGERED_CONTINUOUS 
MODE_GATED_TRANSIENT 
MODE_SOFT_CONTINUOUS 

Definition at line 257 of file acq2xx.h.

enum STATE
 

process states.

Enumerator:
ST_STOP 
ST_ARM 
ST_RUN 
ST_TRIGGER 
ST_POSTPROCESS 
ST_CAPDONE 

Definition at line 206 of file acq2xx.h.


Function Documentation

int acq2xx__acq2script acq2xx__Transaction in  ) 
 

run a script comprising a single Transaction Object, where the Transaction Object may itself be a list on transactions.

Output includes status for each transaction executed

Referenced by soap_serve_acq2xx__acq2script().

int acq2xx__acq2sh char *  command,
char *&  response
 

remote shell command.

Referenced by soap_serve_acq2xx__acq2sh().

int acq2xx__acqcmd char *  command,
char *&  response
 

remote "acqcmd"

Referenced by soap_serve_acq2xx__acqcmd().

int acq2xx__getAcqStatus struct acq2xx__AcqStatus status  ) 
 

output capture state main parameters.

Referenced by acq2xx__setArm(), acq2xx__waitStop(), and soap_serve_acq2xx__getAcqStatus().

int acq2xx__getVersion char *  client_version,
char *&  server_version
 

version check - allows client, server to compare ACQ2XX_H_VERSION

Referenced by soap_serve_acq2xx__getVersion().

int acq2xx__setArm int  block = false,
struct acq2xx__AcqStatus status
 

starts a capture.

Referenced by soap_serve_acq2xx__setArm().

int acq2xx__waitStop int  timeout_sec,
struct acq2xx__AcqStatus status
 

wait until stopped, up until timeout (min=1s, max=10s).

Detect timeout by status.state != ST_STOP

Referenced by soap_serve_acq2xx__waitStop().


Generated on Mon Aug 21 12:39:58 2006 for ACQ2XXWebServices by  doxygen 1.4.4