ACQ2XX_API
Public Member Functions | Protected Member Functions
KddTransport Class Reference
Inheritance diagram for KddTransport:
Transport HostdrvTransport

Public Member Functions

 KddTransport (const char *id)
 ~KddTransport ()
virtual STATUS acqcmd (const char *command, char *response, int maxresponse)
 send an "acqcmd" (acquisition command or query) to the card.
virtual STATUS acq2sh (const char *command, char *response, int maxresponse)
 run a remote shell command or query.
virtual STATUS waitStateChange (int timeout, char *response, int maxresponse)
 block until remote state changes or timeout.
virtual STATUS readChannel (int channel, short *data, int nsamples, int start=0, int stride=1)
 read and output raw data for channel

Protected Member Functions

void openShellSession ()
void closeShellSession ()
void openCmdSession ()
void closeCmdSession ()

Detailed Description

Definition at line 49 of file KddTransport.cpp.


Constructor & Destructor Documentation

KddTransport::KddTransport ( const char *  id) [inline]

Definition at line 145 of file KddTransport.cpp.

References MFMT, openCmdSession(), openShellSession(), and SHELL_FMT.

KddTransport::~KddTransport ( ) [inline]

Definition at line 156 of file KddTransport.cpp.

References closeCmdSession(), and closeShellSession().


Member Function Documentation

virtual STATUS KddTransport::acq2sh ( const char *  command,
char *  response,
int  maxresponse 
) [inline, virtual]

run a remote shell command or query.

Parameters:
command- the command (or query) to send
response- user buffer to collect response.
maxresponse- maximum response size required.
Parameters:
maxresponserun a remote shell command or query.
command- the command (or query) to send
response- user buffer to collect response.
maxresponse- maximum response size required.

Implements Transport.

Reimplemented in HostdrvTransport.

Definition at line 172 of file KddTransport.cpp.

virtual STATUS KddTransport::acqcmd ( const char *  command,
char *  response,
int  maxresponse 
) [inline, virtual]

send an "acqcmd" (acquisition command or query) to the card.

Parameters:
command- the command (or query) to send
response- user buffer to collect response.
maxresponse- maximum response size required.
Parameters:
maxresponsesend an "acqcmd" (acquisition command or query) to the card.
command- the command (or query) to send
response- user buffer to collect response.
maxresponse- maximum response size required.

Implements Transport.

Definition at line 161 of file KddTransport.cpp.

void KddTransport::closeCmdSession ( ) [inline, protected]

Definition at line 140 of file KddTransport.cpp.

Referenced by ~KddTransport().

void KddTransport::closeShellSession ( ) [inline, protected]

Definition at line 134 of file KddTransport.cpp.

Referenced by HostdrvTransport::acq2sh(), and ~KddTransport().

void KddTransport::openCmdSession ( ) [inline, protected]

Definition at line 137 of file KddTransport.cpp.

Referenced by KddTransport().

void KddTransport::openShellSession ( ) [inline, protected]

Definition at line 131 of file KddTransport.cpp.

Referenced by HostdrvTransport::acq2sh(), and KddTransport().

virtual STATUS KddTransport::readChannel ( int  channel,
short *  data,
int  nsamples,
int  start = 0,
int  stride = 1 
) [inline, virtual]

read and output raw data for channel

Parameters:
channel- channel number 1..N
data- caller's buffer
nsamples- max samples to read
start- start sample in data set
stride- stride [subsample] value
Returns:
actual samples returned or STATUS_ERR
Parameters:
strideread and output raw data for channel
channel- channel number 1..N
data- caller's buffer
nsamples- max samples to read
start- start sample in data set
stride- stride [subsample] value
Returns:
actual samples returned or STATUS_ERR
Todo:
  • start, stride dont work at this time

Implements Transport.

Definition at line 190 of file KddTransport.cpp.

virtual STATUS KddTransport::waitStateChange ( int  timeout,
char *  response,
int  maxresponse 
) [inline, virtual]

block until remote state changes or timeout.

Parameters:
maxresponseblock until remote state changes or timeout.

Implements Transport.

Definition at line 183 of file KddTransport.cpp.

References STATUS_WORKTODO.


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