LabjackDriverInterface Class Reference

#include <labjack_driver_interface.h>

Inheritance diagram for LabjackDriverInterface:

List of all members.

Public Member Functions
virtual long	config ()=0
	Configure input/output lines in labjack.
virtual long	disableWatchdog (int activeD)=0
	Disable the watchdog for a D line.
virtual long	enableWatchdog (long timeout, int activeD, long state)=0
	Enable and configure the watchdog.
	LabjackDriverInterface ()
	Constructor.
virtual long	readAI (long channel, float *voltage)=0
	Read the value of one AI line.
virtual long	readAIs (long num_channels, long *channels, float *voltages)=0
	Read the voltage of several AI lines.
virtual long	readD (long channel, long *state)=0
	Read the value of one D line.
virtual long	readDifferentialAI (long channel, float *voltage)=0
	Read the voltage in a differential way of the AI lines.
virtual long	readDIOs (long *stateD, long *stateIO)=0
	Read all the D and IO input lines.
virtual long	readDirectionDs (long *directions)=0
	Read the D line directions (in binary, 0:input and 1:output)
virtual long	readIO (long channel, long *state)=0
	Read the value of one IO line.
virtual long	reset ()=0
	Reset the labjack.
virtual long	writeAO (int channel, float voltage)=0
	Write the value of one AO line.
virtual long	writeAOs (float voltageAO0, float voltageAO1)=0
	Write the voltage of AO0 and AO1 lines.
virtual long	writeD (long channel, long state)=0
	Write the value of one D line.
virtual long	writeDCONFIG (long channel, long state)=0
	Write the value of one D line and configure the D lines.
virtual long	writeDIOs (long *direcD, long *direcIO, long *stateD, long *stateIO)=0
	Write and read all D and IO input lines.
virtual long	writeDIOsCONFIG (long *stateD, long *stateIO)=0
	Write and read all D and IO input lines depending on CONFIG_D and CONFIG_IO.
virtual long	writeIO (long channel, long state)=0
	Write the value of one IO line.
virtual long	writePulse (long pulse_level, long line, long pulse_time, long line_type)=0
	Generate the pulse in one the lines D0..D15.
virtual	~LabjackDriverInterface ()
	Abstract destructor.

---

Detailed Description

Definition at line 27 of file labjack_driver_interface.h.

---

Constructor & Destructor Documentation

LabjackDriverInterface::LabjackDriverInterface

(

)

[inline]

Constructor.

Definition at line 32 of file labjack_driver_interface.h.

virtual LabjackDriverInterface::~LabjackDriverInterface

(

)

[inline, virtual]

Abstract destructor.

Definition at line 39 of file labjack_driver_interface.h.

---

Member Function Documentation

virtual long LabjackDriverInterface::config

(

)

[pure virtual]

Configure input/output lines in labjack.

Returns:

error code or 0 (no error).

Implemented in LjacklmWrapper.

virtual long LabjackDriverInterface::disableWatchdog

(

int

activeD

)

[pure virtual]

Disable the watchdog for a D line.

Parameters:

activeD

D line to disable (0,1,8).

Returns:

error code, 0 (no error) or <0 if any parameter is incorrect.

Implemented in LjacklmWrapper.

virtual long LabjackDriverInterface::enableWatchdog	(	long	timeout,
		int	activeD,
		long	state
	)		[pure virtual]

Enable and configure the watchdog.

Parameters:

timeout	time in seconds to reset (1-715).
activeD	D line to enable (0,1,8).
state	state of the D line (0-1).

Returns:

error code, 0 (no error) or <0 if any parameter is incorrect.

Implemented in LjacklmWrapper.

virtual long LabjackDriverInterface::readAI	(	long	channel,
		float *	voltage
	)		[pure virtual]

Read the value of one AI line.

Parameters:

channel	channel number to read: 0..7. (e.g. to channel=0 => read AI0).
voltage	read voltage to return.

Returns:

error code, 0 (no error) or <0 if any parameter is incorrect.

Implemented in LjacklmWrapper.

virtual long LabjackDriverInterface::readAIs	(	long	num_channels,
		long *	channels,
		float *	voltages
	)		[pure virtual]

Read the voltage of several AI lines.

Parameters:

num_channels	number of channels to read: 1, 2 ó 4.
channels	array with channels values: channels[num_channels] = {0,..,7}. (e.g. to channels={0,1} => read AI0 and AI1).
voltages	array with read voltages to return.

Returns:

error code, 0 (no error) or <0 if any parameter is incorrect.

Implemented in LjacklmWrapper.

virtual long LabjackDriverInterface::readD	(	long	channel,
		long *	state
	)		[pure virtual]

Read the value of one D line.

Parameters:

channel	line to read: channel >= 0 & channel <= 3.
state	value of the line state: state > 0 -> high level, state = 0 -> low level.

Returns:

error code or 0 (no error).

Implemented in LjacklmWrapper.

virtual long LabjackDriverInterface::readDifferentialAI	(	long	channel,
		float *	voltage
	)		[pure virtual]

Read the voltage in a differential way of the AI lines.

Parameters:

channel	channel number to read: 8..11. (e.g. to channel=8 => read difference between AI0 and AI1, and so on).
voltages	array with read voltages to return.

Returns:

error code, 0 (no error) or <0 if any parameter is incorrect.

Implemented in LjacklmWrapper.

virtual long LabjackDriverInterface::readDIOs	(	long *	stateD,
		long *	stateIO
	)		[pure virtual]

Read all the D and IO input lines.

Parameters:

stateD	D line states (D0-D15).
stateIO	IO line states (IO0-IO3).

Returns:

error code or 0 (no error).

Implemented in LjacklmWrapper.

virtual long LabjackDriverInterface::readDirectionDs

(

long *

directions

)

[pure virtual]

Read the D line directions (in binary, 0:input and 1:output)

Parameters:

directions

directions of the D lines.

Returns:

error code, 0 (no error) or <0 if any parameter is incorrect.

Implemented in LjacklmWrapper.

virtual long LabjackDriverInterface::readIO	(	long	channel,
		long *	state
	)		[pure virtual]

Read the value of one IO line.

Parameters:

channel	line to read: channel >= 0 & channel <= 3.
state	value of the line state: state > 0 -> high level, state = 0 -> low level.

Returns:

error code, 0 (no error) or <0 if any parameter is incorrect.

Implemented in LjacklmWrapper.

virtual long LabjackDriverInterface::reset

(

)

[pure virtual]

Reset the labjack.

Returns:

error code or 0 (no error).

Implemented in LjacklmWrapper.

virtual long LabjackDriverInterface::writeAO	(	int	channel,
		float	voltage
	)		[pure virtual]

Write the value of one AO line.

Parameters:

channel	channel number to assign a voltage: channel=0->AO0, channel=1->AO1 and channel=2->AO0&AO1.
voltage	value of the voltage to assign: voltage >= 0.0 & voltage <= 5.0.

Returns:

error code, 0 (no error) or <0 if any parameter is incorrect.

Implemented in LjacklmWrapper.

virtual long LabjackDriverInterface::writeAOs	(	float	voltageAO0,
		float	voltageAO1
	)		[pure virtual]

Write the voltage of AO0 and AO1 lines.

Parameters:

voltageAO0	voltage value to assign to AO0 (voltageAO0 >= 0.0 & voltageAO0 <= 5.0).
voltageAO1	voltage value to assign to AO1 (voltageAO1 >= 0.0 & voltageAO1 <= 5.0).

Returns:

error code, 0 (no error) or <0 if any parameter is incorrect.

Implemented in LjacklmWrapper.

virtual long LabjackDriverInterface::writeD	(	long	channel,
		long	state
	)		[pure virtual]

Write the value of one D line.

Parameters:

channel	line to read: channel >= 0 & channel <= 3.
state	value of the line state: state > 0 -> high level, state = 0 -> low level.

Returns:

error code or 0 (no error).

Implemented in LjacklmWrapper.

virtual long LabjackDriverInterface::writeDCONFIG	(	long	channel,
		long	state
	)		[pure virtual]

Write the value of one D line and configure the D lines.

Parameters:

channel	line to read: channel >= 0 & channel <= 3.
state	value of the line state: state > 0 -> high level, state = 0 -> low level.

Returns:

error code or 0 (no error).

Implemented in LjacklmWrapper.

virtual long LabjackDriverInterface::writeDIOs	(	long *	direcD,
		long *	direcIO,
		long *	stateD,
		long *	stateIO
	)		[pure virtual]

Write and read all D and IO input lines.

Parameters:

direcD	D lines direction (0=input, 1=output).
direcIO	IO lines direction (0=input, 1=output).
stateD	D lines level (D0-D15).
stateIO	IO lines level (IO0-IO3).

Returns:

error code, 0 (no error) or <0 if any parameter is incorrect.

Implemented in LjacklmWrapper.

virtual long LabjackDriverInterface::writeDIOsCONFIG	(	long *	stateD,
		long *	stateIO
	)		[pure virtual]

Write and read all D and IO input lines depending on CONFIG_D and CONFIG_IO.

Parameters:

stateD	D lines level (D0-D15).
stateIO	IO lines level (IO0-IO3).

Returns:

error code, 0 (no error) or <0 if any parameter is incorrect.

Implemented in LjacklmWrapper.

virtual long LabjackDriverInterface::writeIO	(	long	channel,
		long	state
	)		[pure virtual]

Write the value of one IO line.

Parameters:

channel	line to read: channel >= 0 & channel <= 3.
state	value of the line state: state > 0 -> high level, state = 0 -> low level.

Returns:

error code, 0 (no error) or <0 if any parameter is incorrect.

Implemented in LjacklmWrapper.

virtual long LabjackDriverInterface::writePulse	(	long	pulse_level,
		long	line,
		long	pulse_time,
		long	line_type
	)		[pure virtual]

Generate the pulse in one the lines D0..D15.

Parameters:

pulse_level	pulse level: 0->high level, 0->low level.
line	line to use (for lines D:0..15; for lines IO:0..3).
pulse_time	time in microseconds for a pulse (1..2000000).
line_type	type of line, 0=D line, 1=IO line

Returns:

error code, 0 (no error) or <0 if any parameter is incorrect.

Implemented in LjacklmWrapper.

---

The documentation for this class was generated from the following file:

• labjack_driver_interface.h