asyn  4-32
Public Member Functions | List of all members
asynCommonClient Class Reference

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

#include <asynPortClient.h>

Inheritance diagram for asynCommonClient:
asynPortClient

Public Member Functions

 asynCommonClient (const char *portName, int addr, const char *drvInfo, double timeout=DEFAULT_TIMEOUT)
 Constructor for asynCommon class. More...
 
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 asynPortClient
 asynPortClient (const char *portName, int addr, const char *asynInterfaceType, const char *drvInfo, double timeout)
 Constructor for asynPortClient class. More...
 
virtual ~asynPortClient ()
 Destructor for asynPortClient class Frees all allocated resources. More...
 
void setTimeout (double timeout)
 
void report (FILE *fp, int details)
 Reports the properties of this client. More...
 

Additional Inherited Members

- Protected Attributes inherited from asynPortClient
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]portNameThe name of the asyn port to connect to
[in]addrThe address on the asyn port to connect to
[in]drvInfoThe drvInfo string to identify which property of the port is being connected to
[in]timeoutThe default timeout for all communications between the client and the port driver
virtual asynCommonClient::~asynCommonClient ( )
inlinevirtual

Destructor for asynCommon class.

Disconnects from port, frees resources.

Member Function Documentation

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]fpThe file pointer to write the report to
[in]detailsThe level of detail for the report

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