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. More...

	asynOptionClient (const char portName, const char drvInfo, int addr=0, double timeout=DEFAULT_TIMEOUT)

virtual	~asynOptionClient ()
	Destructor for asynOption class. More...

virtual asynStatus	getOption (const char key, char value, int maxChars)
	Get an option from the port driver. More...

virtual asynStatus	setOption (const char key, const char value)
	Sets an option in the port driver. More...

Public Member Functions inherited from asynParamClient
	asynParamClient (const char portName, int addr, const char asynInterfaceType, const char *drvInfo, double timeout)
	Constructor for asynParamClient class. More...

virtual	~asynParamClient ()
	Destructor for asynParamClient class Frees all allocated resources. More...

void	setTimeout (double timeout)

void	report (FILE *fp, int details)
	Reports the properties of this client. More...

char *	getPortName ()

char *	getAsynInterfaceType ()

Additional Inherited Members
Protected Attributes inherited from asynParamClient
asynUser *	pasynUser_

asynUser *	pasynUserSyncIO_

asynInterface *	pasynInterface_

double	timeout_

char *	portName_

int	addr_

char *	asynInterfaceType_

char *	drvInfo_

void *	drvPvt

void *	interruptPvt_

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

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

inline

virtual asynOptionClient::~asynOptionClient ( )

inlinevirtual

Destructor for asynOption class.

Disconnects from port, frees resources.

virtual asynStatus asynOptionClient::getOption	(	const char *	key,
		char *	value,
		int	maxChars
	)

inlinevirtual

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
	)

inlinevirtual

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: