moccos mizuki / ATP3011F4
Embed: (wiki syntax)

« Back to documentation index

ATP3011F4 Class Reference

ATP3011F4 Class Reference

ATP3011F4 controller abstract base class. More...

#include <ATP3011F4.h>

Inherited by ATP3011F4UART.

Public Member Functions

virtual bool init ()=0
 Initialize connection.
virtual bool send (const char *str)=0
 Send string.
virtual bool sendr (const char *str)=0
 Send string with ''.
virtual void waitCompletion ()=0
 Wait until finishing talk.
const char * getReturnCodePtr ()
 Gets previous error code.
int getErrorCode ()
 Send chime J.
void chimeJ ()
 Send chime J.
void chimeK ()
 Send chime K.
void version ()
 Ask version.
void sendBreak ()
 Send break.
bool sendNumPlain (int val)
 send <NUM val="val">
bool sendNumPlain (const char *val)
 send <NUM val="val">
bool sendNum (const char *val, const char *counter=NULL)
 Send <NUMK val="val" counter="counter"> If counter is null, send <NUMK val="val">
bool sendNum (int val, const char *counter=NULL)
 Send <NUMK val="val" counter="counter"> If counter is null, send <NUMK val="val">
bool sendAlpha (const char *val)
 send <ALPHA val="val">

Detailed Description

ATP3011F4 controller abstract base class.

Author:
moccos <tt.izawa, gmail>

Definition at line 12 of file ATP3011F4.h.


Member Function Documentation

void chimeJ (  )

Send chime J.

Definition at line 40 of file ATP3011F4.h.

void chimeK (  )

Send chime K.

Definition at line 43 of file ATP3011F4.h.

int getErrorCode (  )

Send chime J.

Definition at line 5 of file ATP3011F4.cpp.

const char* getReturnCodePtr (  )

Gets previous error code.

Return values:
-1if previous response is not error code.
Returns:
error code

Definition at line 34 of file ATP3011F4.h.

virtual bool init (  ) [pure virtual]

Initialize connection.

Implemented in ATP3011F4UART.

virtual bool send ( const char *  str ) [pure virtual]

Send string.

Implemented in ATP3011F4UART.

bool sendAlpha ( const char *  val )

send <ALPHA val="val">

Definition at line 46 of file ATP3011F4.cpp.

void sendBreak (  )

Send break.

Definition at line 10 of file ATP3011F4.cpp.

bool sendNum ( const char *  val,
const char *  counter = NULL 
)

Send <NUMK val="val" counter="counter"> If counter is null, send <NUMK val="val">

Definition at line 35 of file ATP3011F4.cpp.

bool sendNum ( int  val,
const char *  counter = NULL 
)

Send <NUMK val="val" counter="counter"> If counter is null, send <NUMK val="val">

Definition at line 29 of file ATP3011F4.cpp.

bool sendNumPlain ( int  val )

send <NUM val="val">

Definition at line 15 of file ATP3011F4.cpp.

bool sendNumPlain ( const char *  val )

send <NUM val="val">

Definition at line 21 of file ATP3011F4.cpp.

virtual bool sendr ( const char *  str ) [pure virtual]

Send string with ''.

Implemented in ATP3011F4UART.

void version (  )

Ask version.

Definition at line 46 of file ATP3011F4.h.

virtual void waitCompletion (  ) [pure virtual]

Wait until finishing talk.

Implemented in ATP3011F4UART.