asyn  4-34
Public Member Functions | List of all members
asynEnumClient Class Reference

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

#include <asynPortClient.h>

Inheritance diagram for asynEnumClient:
asynPortClient

Public Member Functions

 asynEnumClient (const char *portName, int addr, const char *drvInfo, double timeout=DEFAULT_TIMEOUT)
 Constructor for asynEnum class. More...
 
virtual ~asynEnumClient ()
 Destructor for asynEnum class. More...
 
virtual asynStatus read (char *strings[], int values[], int severities[], size_t nElements, size_t *nIn)
 Reads enum strings, values, and severities from the port driver. More...
 
virtual asynStatus write (char *strings[], int values[], int severities[], size_t nElements)
 Writes enum strings, values, and severities to the port driver. 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 asynEnum interface.

Constructor & Destructor Documentation

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

Constructor for asynEnum 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 asynEnumClient::~asynEnumClient ( )
inlinevirtual

Destructor for asynEnum class.

Disconnects from port, frees resources.

Member Function Documentation

virtual asynStatus asynEnumClient::read ( char *  strings[],
int  values[],
int  severities[],
size_t  nElements,
size_t *  nIn 
)
inlinevirtual

Reads enum strings, values, and severities from the port driver.

Parameters
[out]stringsThe enum strings to read from the driver
[out]valuesThe enum values to read from the driver
[out]severitiesThe enum severities to read from the driver
[in]nElementsThe number of elements in the strings, value, and severities arrays
[in]nInThe number of elements actually read from the driver
virtual asynStatus asynEnumClient::write ( char *  strings[],
int  values[],
int  severities[],
size_t  nElements 
)
inlinevirtual

Writes enum strings, values, and severities to the port driver.

Parameters
[out]stringsThe enum strings to write to the driver
[out]valuesThe enum values to write to the driver
[out]severitiesThe enum severities to write to the driver
[in]nElementsThe number of elements in the strings, value, and severities arrays

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