Class for asyn port clients to communicate on the asynEnum interface. More...

Inheritance diagram for asynEnumClient:

Public Member Functions
	asynEnumClient (const char portName, int addr, const char drvInfo, double timeout=DEFAULT_TIMEOUT)
	Constructor for asynEnum class.
virtual	~asynEnumClient ()
	Destructor for asynEnum class.
virtual asynStatus	read (char strings[], int values[], int severities[], size_t nElements, size_t nIn)
	Reads enum strings, values, and severities from the port driver.
virtual asynStatus	write (char *strings[], int values[], int severities[], size_t nElements)
	Writes enum strings, values, and severities to the port driver.

Detailed Description

Class for asyn port clients to communicate on the asynEnum interface.

Constructor & Destructor Documentation

asynEnumClient::asynEnumClient	(	const char *	portName,
		int	addr,
		const char *	drvInfo,
		double	timeout = `DEFAULT_TIMEOUT`
	)		`[inline]`

Constructor for asynEnum class.

Parameters:

[in]	portName	The name of the asyn port to connect to
[in]	addr	The address on the asyn port to connect to
[in]	drvInfo	The drvInfo string to identify which property of the port is being connected to
[in]	timeout	The default timeout for all communications between the client and the port driver

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

Destructor for asynEnum class.

Disconnects from port, frees resources.

virtual asynStatus asynEnumClient::read	(	char *	strings[],
		int	values[],
		int	severities[],
		size_t	nElements,
		size_t *	nIn
	)		`[inline, virtual]`

Reads enum strings, values, and severities from the port driver.

Parameters:

[out]	strings	The enum strings to read from the driver
[out]	values	The enum values to read from the driver
[out]	severities	The enum severities to read from the driver
[in]	nElements	The number of elements in the strings, value, and severities arrays
[in]	nIn	The number of elements actually read from the driver

virtual asynStatus asynEnumClient::write	(	char *	strings[],
		int	values[],
		int	severities[],
		size_t	nElements
	)		`[inline, virtual]`

Writes enum strings, values, and severities to the port driver.

Parameters:

[out]	strings	The enum strings to write to the driver
[out]	values	The enum values to write to the driver
[out]	severities	The enum severities to write to the driver
[in]	nElements	The number of elements in the strings, value, and severities arrays

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