AbstractInterface Class Reference

#include <RobotAPI/drivers/WeissHapticSensor/AbstractInterface.h>

Inheritance diagram for AbstractInterface:

Public Member Functions
	AbstractInterface ()
virtual void	close ()=0
void	fireAndForgetCmd (unsigned char id, unsigned char *payload, unsigned int len, bool pending)
bool	IsConnected () const
void	logText (std::string message)
virtual int	open ()=0
int	read (unsigned char *buf, unsigned int len)
Response	receive (bool pending, unsigned char expectedId)
int	receive (msg_t *msg)
Response	receiveWithoutChecks ()
int	send (unsigned char id, unsigned int len, unsigned char *data)
void	startLogging (std::string file)
Response	submitCmd (unsigned char id, unsigned char *payload, unsigned int len, bool pending)
virtual std::string	toString () const =0
int	write (unsigned char *buf, unsigned int len)
virtual	~AbstractInterface ()

Protected Member Functions
virtual int	readInternal (unsigned char *buf, unsigned int len)=0
virtual int	writeInternal (unsigned char *buf, unsigned int len)=0

Protected Attributes
bool	connected

Friends
std::ostream &	operator<< (std::ostream &strm, const AbstractInterface &a)

Constructor & Destructor Documentation

AbstractInterface()

AbstractInterface

(

)

~AbstractInterface()

~AbstractInterface ( )

virtual

Member Function Documentation

close()

virtual void close ( )

pure virtual

Implemented in SerialInterface.

fireAndForgetCmd()

void fireAndForgetCmd	(	unsigned char	id,
		unsigned char *	payload,
		unsigned int	len,
		bool	pending )

IsConnected()

bool IsConnected ( ) const

inline

logText()

void logText

(

std::string

message

)

open()

virtual int open ( )

pure virtual

Implemented in SerialInterface.

read()

int read	(	unsigned char *	buf,
		unsigned int	len )

readInternal()

virtual int readInternal ( unsigned char * buf, unsigned int len )

protectedpure virtual

Implemented in SerialInterface.

receive() [1/2]

Response receive	(	bool	pending,
		unsigned char	expectedId )

receive() [2/2]

int receive

(

msg_t *

msg

)

receiveWithoutChecks()

Response receiveWithoutChecks

(

)

send()

int send	(	unsigned char	id,
		unsigned int	len,
		unsigned char *	data )

startLogging()

void startLogging

(

std::string

file

)

submitCmd()

Response submitCmd	(	unsigned char	id,
		unsigned char *	payload,
		unsigned int	len,
		bool	pending )

toString()

virtual std::string toString ( ) const

pure virtual

Implemented in SerialInterface.

write()

int write	(	unsigned char *	buf,
		unsigned int	len )

writeInternal()

virtual int writeInternal ( unsigned char * buf, unsigned int len )

protectedpure virtual

Implemented in SerialInterface.

Friends And Related Symbol Documentation

operator<<

std::ostream & operator<< ( std::ostream & strm, const AbstractInterface & a )

friend

Member Data Documentation

connected

bool connected

protected

---

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

• RobotAPI/drivers/WeissHapticSensor/AbstractInterface.h
• RobotAPI/drivers/WeissHapticSensor/AbstractInterface.cpp