asyn  4-31
Public Member Functions | List of all members
asynInt32Client Class Reference

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

#include <asynPortClient.h>

Inheritance diagram for asynInt32Client:
asynPortClient

Public Member Functions

 asynInt32Client (const char *portName, int addr, const char *drvInfo, double timeout=DEFAULT_TIMEOUT)
 Constructor for asynInt32Client class. More...
 
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)
 Registers an interruptCallbackInt32 function that the driver will call when there is a new value. 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 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]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 asynInt32Client::~asynInt32Client ( )
inlinevirtual

Destructor for asynInt32Client class.

Disconnects from port, frees resources.

Member Function Documentation

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]lowThe low limit
[out]highThe high limit
virtual asynStatus asynInt32Client::read ( epicsInt32 *  value)
inlinevirtual

Reads an epicsInt32 value from the port driver.

Parameters
[out]valueThe value read from the port driver
virtual asynStatus asynInt32Client::registerInterruptUser ( interruptCallbackInt32  pCallback)
inlinevirtual

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

Parameters
[in]pCallbackThe address of the callback function
virtual asynStatus asynInt32Client::write ( epicsInt32  value)
inlinevirtual

Writes an epicsInt32 value to the port driver.

Parameters
[in]valueThe value to write to the port driver

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