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

Inheritance diagram for asynInt32Client:

Public Member Functions
	asynInt32Client (const char portName, int addr, const char drvInfo, double timeout=DEFAULT_TIMEOUT)
	Constructor for asynInt32Client class. More...

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

virtual	~asynInt32Client ()
	Destructor for asynInt32Client class. More...

virtual asynStatus	read (epicsInt32 *value)
	Reads an epicsInt32 value from the port driver. More...

virtual asynStatus	write (epicsInt32 value)
	Writes an epicsInt32 value to the port driver. More...

virtual asynStatus	getBounds (epicsInt32 low, epicsInt32 high)
	Returns the lower and upper limits of the range of values from the port driver. More...

virtual asynStatus	registerInterruptUser (interruptCallbackInt32 pCallback, void *userPvt=0)
	Registers an interruptCallbackInt32 function that the driver will call when there is a new value. 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 asynInt32 interface.

Constructor & Destructor Documentation

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

inline

Constructor for asynInt32Client 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

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

inline

virtual asynInt32Client::~asynInt32Client ( )

inlinevirtual

Destructor for asynInt32Client class.

Disconnects from port, frees resources.

virtual asynStatus asynInt32Client::getBounds	(	epicsInt32 *	low,
		epicsInt32 *	high
	)

inlinevirtual

Returns the lower and upper limits of the range of values from the port driver.

Parameters

[out]	low	The low limit
[out]	high	The high limit

virtual asynStatus asynInt32Client::read ( epicsInt32 * value )

inlinevirtual

Reads an epicsInt32 value from the port driver.

Parameters

[out] value The value read from the port driver

virtual asynStatus asynInt32Client::registerInterruptUser	(	interruptCallbackInt32	pCallback,
		void *	userPvt = `0`
	)

inlinevirtual

Registers an interruptCallbackInt32 function that the driver will call when there is a new value.

Parameters

[in]	pCallback	The address of the callback function
[in]	userPvt	The user-defined pointer to be passed to the callback function

virtual asynStatus asynInt32Client::write ( epicsInt32 value )

inlinevirtual

Writes an epicsInt32 value to the port driver.

Parameters

[in] value The value to write to the port driver

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