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

Inheritance diagram for asynCommonClient:

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

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

virtual	~asynCommonClient ()
	Destructor for asynCommon class. More...

virtual void	report (FILE *fp, int details)
	Calls the report method in the driver. More...

virtual asynStatus	connect ()
	Calls the connect method in the driver which attempts to connect to the port device. More...

virtual asynStatus	disconnect ()
	Calls the disconnect method in the driver disconnects from the port device. 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 asynCommon interface.

Constructor & Destructor Documentation

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

inline

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

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

inline

virtual asynCommonClient::~asynCommonClient ( )

inlinevirtual

Destructor for asynCommon class.

Disconnects from port, frees resources.

virtual asynStatus asynCommonClient::connect ( )

inlinevirtual

Calls the connect method in the driver which attempts to connect to the port device.

virtual asynStatus asynCommonClient::disconnect ( )

inlinevirtual

Calls the disconnect method in the driver disconnects from the port device.

virtual void asynCommonClient::report	(	FILE *	fp,
		int	details
	)

inlinevirtual

Calls the report method in the driver.

Parameters

[in]	fp	The file pointer to write the report to
[in]	details	The level of detail for the report

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