asyn 4-25
Public Member Functions
asynGenericPointerClient Class Reference

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

#include <asynPortClient.h>

Inheritance diagram for asynGenericPointerClient:
asynPortClient

List of all members.

Public Member Functions

 asynGenericPointerClient (const char *portName, int addr, const char *drvInfo, double timeout=DEFAULT_TIMEOUT)
 Constructor for asynGenericPointer class.
virtual ~asynGenericPointerClient ()
 Destructor for asynGenericPointer class.
virtual asynStatus read (void *pointer)
 Reads an generic pointer from the port driver.
virtual asynStatus write (void *pointer)
 Writes a generic pointer to the port driver.
virtual asynStatus registerInterruptUser (interruptCallbackGenericPointer pCallback)
 Registers an interruptCallbackGenericPointer function that the driver will call when there is a new value.

Detailed Description

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


Constructor & Destructor Documentation

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

Constructor for asynGenericPointer 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 asynGenericPointerClient::~asynGenericPointerClient ( ) [inline, virtual]

Destructor for asynGenericPointer class.

Disconnects from port, frees resources.


Member Function Documentation

virtual asynStatus asynGenericPointerClient::read ( void *  pointer) [inline, virtual]

Reads an generic pointer from the port driver.

Parameters:
[out]pointerThe pointer to read from the port driver
virtual asynStatus asynGenericPointerClient::registerInterruptUser ( interruptCallbackGenericPointer  pCallback) [inline, virtual]

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

Parameters:
[in]pCallbackThe address of the callback function
virtual asynStatus asynGenericPointerClient::write ( void *  pointer) [inline, virtual]

Writes a generic pointer to the port driver.

Parameters:
[in]pointerThe pointer to write to the port driver

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