HardwareInterface Class Reference

An interface to a hardware device, such as a serial connection. More...

#include <HardwareInterface.h>

Inherited by Serial.

Public Member Functions
virtual bool	Open (char *toOpen)=0
virtual bool	Close ()=0
virtual int	SendData (char *dataToSend)=0

Detailed Description

An interface to a hardware device, such as a serial connection.

Member Function Documentation

virtual bool HardwareInterface::Close ( )

pure virtual

Closes the open connection to the hardware device

Returns

true if a connection was successfully closed false if a connection failed to close or no connection was open

Implemented in Serial.

virtual bool HardwareInterface::Open ( char *  toOpen )

pure virtual

Opens a connection to the hardware device given by toOpen

Parameters

toOpen

the handle to the hardware device

Returns

true if the connection opened successfully false otherwise

Implemented in Serial.

virtual int HardwareInterface::SendData ( char *  dataToSend )

pure virtual

Sends the data given by dataToSend to the hardware device via the open connection

Parameters

dataToSend

the data to be sent to the hardware device in a C string

Returns

0 if no errors occurred while sending the data, non-zero if an error occurred

Implemented in Serial.

---

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

• TactileAPI/include/HardwareInterface.h