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

Inheritance diagram for asynOptionClient:

Public Member Functions
	asynOptionClient (const char portName, int addr, const char drvInfo, double timeout=DEFAULT_TIMEOUT)
	Constructor for asynOption class.
virtual	~asynOptionClient ()
	Destructor for asynOption class.
virtual asynStatus	getOption (const char key, char value, int maxChars)
	Get an option from the port driver.
virtual asynStatus	setOption (const char key, const char value)
	Sets an option in the port driver.

Detailed Description

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

Constructor & Destructor Documentation

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

Constructor for asynOption 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 asynOptionClient::~asynOptionClient ( ) [inline, virtual]

Destructor for asynOption class.

Disconnects from port, frees resources.

virtual asynStatus asynOptionClient::getOption	(	const char *	key,
		char *	value,
		int	maxChars
	)		`[inline, virtual]`

Get an option from the port driver.

Parameters:

[in]	key	The key to read from the port driver
[out]	value	The value to read from the port driver
[in]	maxChars	The size of value

virtual asynStatus asynOptionClient::setOption	(	const char *	key,
		const char *	value
	)		`[inline, virtual]`

Sets an option in the port driver.

Parameters:

[in]	key	The key to set in the port driver
[out]	value	The value to set in the port driver

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