asyn  4-40-1
Public Member Functions | List of all members
asynUInt32DigitalClient Class Reference

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

#include <asynPortClient.h>

Inheritance diagram for asynUInt32DigitalClient:
asynParamClient

Public Member Functions

 asynUInt32DigitalClient (const char *portName, int addr, const char *drvInfo, double timeout=DEFAULT_TIMEOUT)
 Constructor for asynUInt32DigitalClient class. More...
 
 asynUInt32DigitalClient (const char *portName, const char *drvInfo, int addr=0, double timeout=DEFAULT_TIMEOUT)
 
virtual ~asynUInt32DigitalClient ()
 Destructor for asynInt32Client class. More...
 
virtual asynStatus read (epicsUInt32 *value, epicsUInt32 mask)
 Reads an epicsUInt32 value from the port driver. More...
 
virtual asynStatus write (epicsUInt32 value, epicsUInt32 mask)
 Writes an epicsUInt32 value to the port driver. More...
 
virtual asynStatus setInterrupt (epicsUInt32 mask, interruptReason reason)
 Sets the interrupt mask for the specified interrupt reason in the driver. More...
 
virtual asynStatus clearInterrupt (epicsUInt32 mask)
 Clears the interrupt mask in the driver. More...
 
virtual asynStatus getInterrupt (epicsUInt32 *mask, interruptReason reason)
 Gets the current interrupt mask for the specified reason from the driver. More...
 
virtual asynStatus registerInterruptUser (interruptCallbackUInt32Digital pCallback, epicsUInt32 mask, void *userPvt=0)
 Registers an interruptCallbackUInt32Digital 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 asynUInt32Digital interface.

Constructor & Destructor Documentation

◆ asynUInt32DigitalClient() [1/2]

asynUInt32DigitalClient::asynUInt32DigitalClient ( const char *  portName,
int  addr,
const char *  drvInfo,
double  timeout = DEFAULT_TIMEOUT 
)
inline

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

◆ asynUInt32DigitalClient() [2/2]

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

◆ ~asynUInt32DigitalClient()

virtual asynUInt32DigitalClient::~asynUInt32DigitalClient ( )
inlinevirtual

Destructor for asynInt32Client class.

Disconnects from port, frees resources.

Member Function Documentation

◆ clearInterrupt()

virtual asynStatus asynUInt32DigitalClient::clearInterrupt ( epicsUInt32  mask)
inlinevirtual

Clears the interrupt mask in the driver.

Parameters
[in]maskThe interrupt mask

◆ getInterrupt()

virtual asynStatus asynUInt32DigitalClient::getInterrupt ( epicsUInt32 *  mask,
interruptReason  reason 
)
inlinevirtual

Gets the current interrupt mask for the specified reason from the driver.

Parameters
[out]maskThe interrupt mask
[in]reasonThe interrupt reason

◆ read()

virtual asynStatus asynUInt32DigitalClient::read ( epicsUInt32 *  value,
epicsUInt32  mask 
)
inlinevirtual

Reads an epicsUInt32 value from the port driver.

Parameters
[out]valueThe value read from the port driver
[in]maskThe mask to use when reading the value

◆ registerInterruptUser()

virtual asynStatus asynUInt32DigitalClient::registerInterruptUser ( interruptCallbackUInt32Digital  pCallback,
epicsUInt32  mask,
void *  userPvt = 0 
)
inlinevirtual

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

Parameters
[in]pCallbackThe address of the callback function
[in]maskThe mask to use when determining whether to do the callback
[in]userPvtThe user-defined pointer to be passed to the callback function

◆ setInterrupt()

virtual asynStatus asynUInt32DigitalClient::setInterrupt ( epicsUInt32  mask,
interruptReason  reason 
)
inlinevirtual

Sets the interrupt mask for the specified interrupt reason in the driver.

Parameters
[in]maskThe interrupt mask
[in]reasonThe interrupt reason

◆ write()

virtual asynStatus asynUInt32DigitalClient::write ( epicsUInt32  value,
epicsUInt32  mask 
)
inlinevirtual

Writes an epicsUInt32 value to the port driver.

Parameters
[in]valueThe value to write to the port driver
[in]maskThe mask to use when writing the value

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