asyn 4-28
Public Member Functions
asynOptionClient Class Reference

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

#include <asynPortClient.h>

Inheritance diagram for asynOptionClient:
asynPortClient

List of all members.

Public Member Functions

 asynOptionClient (const char *portName, int addr, const char *drvInfo, double timeout=DEFAULT_TIMEOUT)
 Constructor for asynOption class.
virtual ~asynOptionClient ()
 Destructor for asynOption class.
virtual asynStatus getOption (const char *key, char *value, int maxChars)
 Get an option from the port driver.
virtual asynStatus setOption (const char *key, const char *value)
 Sets an option in the port driver.

Detailed Description

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


Constructor & Destructor Documentation

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

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

Destructor for asynOption class.

Disconnects from port, frees resources.


Member Function Documentation

virtual asynStatus asynOptionClient::getOption ( const char *  key,
char *  value,
int  maxChars 
) [inline, virtual]

Get an option from the port driver.

Parameters:
[in]keyThe key to read from the port driver
[out]valueThe value to read from the port driver
[in]maxCharsThe size of value
virtual asynStatus asynOptionClient::setOption ( const char *  key,
const char *  value 
) [inline, virtual]

Sets an option in the port driver.

Parameters:
[in]keyThe key to set in the port driver
[out]valueThe value to set in the port driver

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