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

Inheritance diagram for asynGenericPointerClient:

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

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

virtual	~asynGenericPointerClient ()
	Destructor for asynGenericPointer class. More...

virtual asynStatus	read (void *pointer)
	Reads an generic pointer from the port driver. More...

virtual asynStatus	write (void *pointer)
	Writes a generic pointer to the port driver. More...

virtual asynStatus	registerInterruptUser (interruptCallbackGenericPointer pCallback, void *userPvt=0)
	Registers an interruptCallbackGenericPointer 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 asynGenericPointer interface.

Constructor & Destructor Documentation

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

inline

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

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

inline

virtual asynGenericPointerClient::~asynGenericPointerClient ( )

inlinevirtual

Destructor for asynGenericPointer class.

Disconnects from port, frees resources.

virtual asynStatus asynGenericPointerClient::read ( void * pointer )

inlinevirtual

Reads an generic pointer from the port driver.

Parameters

[out] pointer The pointer to read from the port driver

virtual asynStatus asynGenericPointerClient::registerInterruptUser	(	interruptCallbackGenericPointer	pCallback,
		void *	userPvt = `0`
	)

inlinevirtual

Registers an interruptCallbackGenericPointer 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 asynGenericPointerClient::write ( void * pointer )

inlinevirtual

Writes a generic pointer to the port driver.

Parameters

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

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