Acq2xx class wraps all ACQ2xx functionality. More...

#include <acq2xx_api.h>

Public Member Functions
	Acq2xx (Transport *transport)
	Create a transport independent ACQ protocol object.
virtual	~Acq2xx ()
Transport *	getTransport ()
STATUS	setRoute (enum acq2xx_Dx dx, enum acq2xx_RoutePort in, enum acq2xx_RoutePort out, enum acq2xx_RoutePort out2=R_NONE, enum acq2xx_RoutePort out3=R_NONE)
	make a signal routing (connection).
STATUS	setExternalClock (enum acq2xx__DIx dix, int div=1, enum acq2xx__DOx dox=DO_NONE)
	set External Clock definition.
STATUS	setInternalClock (int hz, enum acq2xx__DOx dox=DO_NONE)
	set Internal Clock defiition.
STATUS	getInternalClock (int &hz)
	get the actual Internal Clock frequency.
STATUS	getAvailableChannels (int &maxChannels)
	get the number of channels on the card.
STATUS	selectChannels (const char *channelMask)
	set the active channel mask.
STATUS	getSelectedChannels (char channelMask, int count)
	get the actual effective channel mask.
STATUS	getChannelRanges (acq2xx_VRange *ranges, int maxRanges)
	get a list of calibrated range values for each channel.
STATUS	setPrePostMode (int prelen, int postlen, enum acq2xx__DIx dix=DI3, enum acq2xx__EDGE edge=EDGE_FALLING)
	configure the capture Mode.
STATUS	setTriggeredPostMode (int postlen)
	configure a capture with POST samples only and a hard trigger
STATUS	setSoftTriggeredMode (int postlen)
	configure a capture with SOFT TRIGGER.
STATUS	setArm ()
	arm the card to start the capture.
STATUS	setAbort ()
	abort a capture
STATUS	getState (enum STATE &state)
	output card state.
STATUS	waitState (enum STATE state, int timeout=10000)
	wait for selected State to occur, or timeout
STATUS	getNumSamples (int total, int pre=0, int post=0, int elapsed=0)
	query current capture state.
STATUS	readChannel (int channel, short *data, int nsamples, int start=0, int stride=1)
	read and output raw data for channel
STATUS	readChannelVolts (int channel, float *data_volts, int nsamples, int start=0, int stride=1)
	read and output calibrated data for channel
STATUS	readStreamingFrame (Frame *frame, unsigned id)
	For streaming data, read the frame.
STATUS	stopStreaming (void)
	stops and clears up a previous streaming connection
Protected Attributes
Transport *	transport
acq2xx_VRange *	ranges
int	ai
int	ao

Detailed Description

Acq2xx class wraps all ACQ2xx functionality.

Acq2xx uses a Transport instance to take care of communications, so the same Acq2xx class works with any Transport.

Definition at line 126 of file acq2xx_api.h.

Constructor & Destructor Documentation

Acq2xx::Acq2xx ( Transport * transport )

Create a transport independent ACQ protocol object.

Definition at line 146 of file acq2xx_api.cpp.

virtual Acq2xx::~Acq2xx ( ) [inline, virtual]

Definition at line 136 of file acq2xx_api.h.

Member Function Documentation

STATUS Acq2xx::getAvailableChannels ( int & maxChannels )

get the number of channels on the card.

Parameters:

maxChannels - output available channels.

Parameters:

maxChannels	get the number of channels on the card.
maxChannels	- output available channels.

Definition at line 227 of file acq2xx_api.cpp.

References Transport::acqcmd(), ai, ao, ERR_SCAN2, REPLY, RETERR, STATUS_OK, and transport.

Referenced by main(), and readChannelVolts().

STATUS Acq2xx::getChannelRanges	(	acq2xx_VRange *	ranges,
		int	maxRanges
	)

get a list of calibrated range values for each channel.

Parameters:

ranges	- user allocated buffer to hold values. index from 1
maxRanges	- length of user buffer

Parameters:

maxRanges	get a list of calibrated range values for each channel.
ranges	- user allocated buffer to hold values.
maxRanges	- length of user buffer

Definition at line 291 of file acq2xx_api.cpp.

References Transport::acq2sh(), ERR_SCAN2, RETERR, STATUS_OK, and transport.

Referenced by readChannelVolts().

STATUS Acq2xx::getInternalClock ( int & hz )

get the actual Internal Clock frequency.

Parameters:

hz	- output value

Parameters:

hz	get the actual Internal Clock frequency.
hz	- output value

Definition at line 211 of file acq2xx_api.cpp.

References Transport::acqcmd(), ERR_SCAN1, REPLY, RETERR, STATUS_OK, and transport.

Referenced by main().

STATUS Acq2xx::getNumSamples	(	int *	total,
		int *	pre = `0`,
		int *	post = `0`,
		int *	elapsed = `0`
	)

query current capture state.

Parameters:

total	- output total samples
pre	- output pre trigger samples
post	- output post- trigger samples
elapsed	- output samples since arm NB: any param can be null, and is then ignored

Parameters:

elapsed	query current capture state.
total	- output total samples
pre	- output pre trigger samples
post	- output post- trigger samples
elapsed	- output samples since arm NB: any param can be null, and is then ignored

Definition at line 394 of file acq2xx_api.cpp.

References Transport::acqcmd(), response, RETERR, STATUS_OK, and transport.

Referenced by main().

STATUS Acq2xx::getSelectedChannels	(	char *	channelMask,
		int *	count
	)

get the actual effective channel mask.

Parameters:

channelMask	- outputs the actual mask
count	- outputs selected channel count

Parameters:

count	get the actual effective channel mask.
channelMask	- outputs the actual mask
count	- outputs selected channel count

Definition at line 266 of file acq2xx_api.cpp.

References Transport::acqcmd(), ERR_SCAN1, REPLY, RETERR, STATUS_OK, and transport.

Referenced by main().

STATUS Acq2xx::getState ( enum STATE & state )

output card state.

Parameters:

state - output state value.

Parameters:

state	output card state.
state	- output state value.

Definition at line 366 of file acq2xx_api.cpp.

References Transport::acqcmd(), ERR_SCAN1, REPLY, RETERR, STATUS_OK, and transport.

Referenced by main().

Transport* Acq2xx::getTransport ( ) [inline]

Definition at line 140 of file acq2xx_api.h.

References transport.

Referenced by AcqType::getAcqType(), and main().

STATUS Acq2xx::readChannel	(	int	channel,
		short *	data,
		int	nsamples,
		int	start = `0`,
		int	stride = `1`
	)

read and output raw data for channel

Parameters:

channel	- channel number 1..N
data	- caller's buffer
nsamples	- max samples to read
start	- start sample in data set
stride	- stride [subsample] value

Returns:: actual samples returned or STATUS_ERR

Parameters:

stride	read and output raw data for channel
channel	- channel number 1..N
data	- caller's buffer
nsamples	- max samples to read
start	- start sample in data set
stride	- stride [subsample] value

Returns:: actual samples returned or STATUS_ERR

Definition at line 425 of file acq2xx_api.cpp.

References Transport::readChannel(), and transport.

Referenced by FetchesRaw::readChannel(), and readChannelVolts().

STATUS Acq2xx::readChannelVolts	(	int	channel,
		float *	data_volts,
		int	nsamples,
		int	start = `0`,
		int	stride = `1`
	)

read and output calibrated data for channel

Parameters:

channel	- channel number 1..N
data_volts	- caller's buffer
nsamples	- max samples to read
start	- start sample in data set
stride	- stride [subsample] value

Returns:: actual samples returned or STATUS_ERR

Parameters:

stride	read and output calibrated data for channel
channel	- channel number 1..N
data_volts	- caller's buffer
nsamples	- max samples to read
start	- start sample in data set
stride	- stride [subsample] value

Returns:: actual samples returned or STATUS_ERR

Definition at line 439 of file acq2xx_api.cpp.

References getAvailableChannels(), getChannelRanges(), nsamples, R1, ranges, readChannel(), RR, STATUS_ERR, STATUS_IS_OK, acq2xx_VRange::vmax, and acq2xx_VRange::vmin.

Referenced by FetchesVolts::readChannel().

STATUS Acq2xx::readStreamingFrame	(	Frame *	frame,
		unsigned	id
	)

For streaming data, read the frame.

Parameters:

frame	- caller buffer to fill with data
id	- previous frame # - id=0 means "start streaming"

Returns:: STATUS_OK or STATUS_ERR

Parameters:

id	For streaming data, read the frame
frame	- caller buffer to fill with data
id	- previous frame # - id=0 means "start streaming"

Returns:: STATUS_OK or STATUS_ERR

Definition at line 496 of file acq2xx_api.cpp.

References Transport::readStreamingFrame(), and transport.

Referenced by ConcreteDataStreamer< T >::streamData().

STATUS Acq2xx::selectChannels ( const char * channelMask )

set the active channel mask.

NB not all masks are valid, hardware will select nearest mask that includes all channels.

Parameters:

channelMask - mask selects active channels 1=> enabled

Parameters:

channelMask	set the active channel mask. NB not all masks are valid, hardware will select nearest mask that includes all channels.
channelMask	- mask selects active channels 1=> enabled

Definition at line 249 of file acq2xx_api.cpp.

References Transport::acqcmd(), CMD, REPLY, RETERR, STATUS_OK, and transport.

Referenced by main().

STATUS Acq2xx::setAbort ( )

abort a capture

Definition at line 356 of file acq2xx_api.cpp.

References Transport::acqcmd(), REPLY, RETERR, STATUS_OK, and transport.

Referenced by main().

STATUS Acq2xx::setArm ( )

arm the card to start the capture.

Definition at line 346 of file acq2xx_api.cpp.

References Transport::acqcmd(), REPLY, RETERR, STATUS_OK, and transport.

Referenced by main().

STATUS Acq2xx::setExternalClock	(	enum acq2xx__DIx	dix,
		int	div = `1`,
		enum acq2xx__DOx	dox = `DO_NONE`
	)

set External Clock definition.

Parameters:

dix	- the signal
div	- integer divide of dix
dox	- optional output for divided signal

Parameters:

dox	set External Clock definition.
dix	- the signal
div	- integer divide of dix
dox	- optional output for divided signal

Definition at line 179 of file acq2xx_api.cpp.

References STATUS_WORKTODO.

STATUS Acq2xx::setInternalClock	(	int	hz,
		enum acq2xx__DOx	dox = `DO_NONE`
	)

set Internal Clock defiition.

Parameters:

hz	- frequency in Hz
dox	- output the clock on this line

Parameters:

dox	set Internal Clock defiition.
hz	- frequency in Hz
dox	- output the clock on this line

Definition at line 190 of file acq2xx_api.cpp.

References Transport::acqcmd(), CMD, DO_NONE, REPLY, RETERR, STATUS_OK, toString(), and transport.

Referenced by main().

STATUS Acq2xx::setPrePostMode	(	int	prelen,
		int	postlen,
		enum acq2xx__DIx	dix = `DI3`,
		enum acq2xx__EDGE	edge = `EDGE_FALLING`
	)

configure the capture Mode.

Parameters:

prelen	- number of samples before trigger
postlen	- number of samples after trigger
dix	- signal line for trigger
edge	- sense of the signal

Parameters:

edge	configure the capture Mode.
prelen	- number of samples before trigger
postlen	- number of samples after trigger
dix	- signal line for trigger
edge	- sense of the signal

Definition at line 322 of file acq2xx_api.cpp.

References Transport::acq2sh(), CMD, DI_NONE, REPLY, RETERR, STATUS_OK, toString(), and transport.

Referenced by main(), setSoftTriggeredMode(), and setTriggeredPostMode().

STATUS Acq2xx::setRoute	(	enum acq2xx_Dx	dx,
		enum acq2xx_RoutePort	in,
		enum acq2xx_RoutePort	out,
		enum acq2xx_RoutePort	out2 = `R_NONE`,
		enum acq2xx_RoutePort	out3 = `R_NONE`
	)