asyn 4-26
Public Member Functions
asynUInt32DigitalClient Class Reference

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

#include <asynPortClient.h>

Inheritance diagram for asynUInt32DigitalClient:
asynPortClient

List of all members.

Public Member Functions

 asynUInt32DigitalClient (const char *portName, int addr, const char *drvInfo, double timeout=DEFAULT_TIMEOUT)
 Constructor for asynUInt32DigitalClient class.
virtual ~asynUInt32DigitalClient ()
 Destructor for asynInt32Client class.
virtual asynStatus read (epicsUInt32 *value, epicsUInt32 mask)
 Reads an epicsUInt32 value from the port driver.
virtual asynStatus write (epicsUInt32 value, epicsUInt32 mask)
 Writes an epicsUInt32 value to the port driver.
virtual asynStatus setInterrupt (epicsUInt32 mask, interruptReason reason)
 Sets the interrupt mask for the specified interrupt reason in the driver.
virtual asynStatus clearInterrupt (epicsUInt32 mask)
 Clears the interrupt mask in the driver.
virtual asynStatus getInterrupt (epicsUInt32 *mask, interruptReason reason)
 Gets the current interrupt mask for the specified reason from the driver.
virtual asynStatus registerInterruptUser (interruptCallbackUInt32Digital pCallback, epicsUInt32 mask)
 Registers an interruptCallbackUInt32Digital function that the driver will call when there is a new value.

Detailed Description

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


Constructor & Destructor Documentation

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
virtual asynUInt32DigitalClient::~asynUInt32DigitalClient ( ) [inline, virtual]

Destructor for asynInt32Client class.

Disconnects from port, frees resources.


Member Function Documentation

virtual asynStatus asynUInt32DigitalClient::clearInterrupt ( epicsUInt32  mask) [inline, virtual]

Clears the interrupt mask in the driver.

Parameters:
[in]maskThe interrupt mask
virtual asynStatus asynUInt32DigitalClient::getInterrupt ( epicsUInt32 *  mask,
interruptReason  reason 
) [inline, virtual]

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

Parameters:
[out]maskThe interrupt mask
[in]reasonThe interrupt reason
virtual asynStatus asynUInt32DigitalClient::read ( epicsUInt32 *  value,
epicsUInt32  mask 
) [inline, virtual]

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
virtual asynStatus asynUInt32DigitalClient::registerInterruptUser ( interruptCallbackUInt32Digital  pCallback,
epicsUInt32  mask 
) [inline, virtual]

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
virtual asynStatus asynUInt32DigitalClient::setInterrupt ( epicsUInt32  mask,
interruptReason  reason 
) [inline, virtual]

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

Parameters:
[in]maskThe interrupt mask
[in]reasonThe interrupt reason
virtual asynStatus asynUInt32DigitalClient::write ( epicsUInt32  value,
epicsUInt32  mask 
) [inline, virtual]

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: