IHardwareInterface Class Reference

#include <IHardwareInterface.h>

Inheritance diagram for IHardwareInterface:

Public Member Functions
virtual	~IHardwareInterface ()
virtual void	write (IMessage *msg)=0
virtual std::list< IMessage * > *	read ()=0

Detailed Description

Interface that describes what functions hardware adapters should expose to the rest of the program.

Definition at line 12 of file IHardwareInterface.h.

Constructor & Destructor Documentation

virtual IHardwareInterface::~IHardwareInterface ( )

inlinevirtual

Deconstructor. Delete any pointer references.

Definition at line 17 of file IHardwareInterface.h.

Member Function Documentation

virtual std::list<IMessage*>* IHardwareInterface::read ( )

pure virtual

Read data from the peripheral

Returns

A list of Messages

Implemented in EncoderAdapter, MotorAdapter, and MockHardwareInterface.

virtual void IHardwareInterface::write ( IMessage *  msg )

pure virtual

Write a message to the peripheral. Deletes the message pointer.

Parameters

msg	A Message to be sent

Implemented in EncoderAdapter, MotorAdapter, and MockHardwareInterface.

---

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

• include/hardwareinterface/IHardwareInterface.h