DUNE::Hardware::UCTK::Interface Class Reference

Public Member Functions
virtual	~Interface (void)
void	open (bool query=true)
bool	poll (double timeout)
void	write (const uint8_t *data, unsigned data_size)
unsigned	read (uint8_t *data, unsigned data_size)
void	flush (void)
FirmwareInfo	getFirmwareInfo (void)
void	resetDevice (void)
bool	sendFrame (Frame &frame, double timeout=1.0)
void	setBootStop (bool value)
Frame *	pop (void)
unsigned	consume (void)

Protected Member Functions
virtual void	doOpen (void)=0
virtual bool	doPoll (double timeout)=0
virtual void	doWrite (const uint8_t *data, unsigned data_size)=0
virtual unsigned	doRead (uint8_t *data, unsigned data_size)=0
virtual void	doFlush (void)=0

Constructor & Destructor Documentation

DUNE::Hardware::UCTK::Interface::~Interface ( void  )

virtual

Member Function Documentation

unsigned DUNE::Hardware::UCTK::Interface::consume ( void  )

inline

References DUNE::Hardware::UCTK::Parser::parse(), and read().

virtual void DUNE::Hardware::UCTK::Interface::doFlush ( void  )

protectedpure virtual

Referenced by flush().

virtual void DUNE::Hardware::UCTK::Interface::doOpen ( void  )

protectedpure virtual

Referenced by open().

virtual bool DUNE::Hardware::UCTK::Interface::doPoll ( double  timeout )

protectedpure virtual

Referenced by poll().

virtual unsigned DUNE::Hardware::UCTK::Interface::doRead ( uint8_t *  data, unsigned  data_size  )

protectedpure virtual

Referenced by read().

virtual void DUNE::Hardware::UCTK::Interface::doWrite ( const uint8_t *  data, unsigned  data_size  )

protectedpure virtual

Referenced by write().

void DUNE::Hardware::UCTK::Interface::flush ( void  )

inline

References doFlush().

FirmwareInfo DUNE::Hardware::UCTK::Interface::getFirmwareInfo

(

void

)

Referenced by DUNE::Hardware::UCTK::Bootloader::Bootloader(), open(), and DUNE::Hardware::UCTK::Bootloader::~Bootloader().

void DUNE::Hardware::UCTK::Interface::open

(

bool

query = true

)

References doOpen(), and getFirmwareInfo().

bool DUNE::Hardware::UCTK::Interface::poll ( double  timeout )

inline

References doPoll().

Frame* DUNE::Hardware::UCTK::Interface::pop ( void  )

inline

unsigned DUNE::Hardware::UCTK::Interface::read ( uint8_t *  data, unsigned  data_size  )

inline

References doRead().

Referenced by consume().

void DUNE::Hardware::UCTK::Interface::resetDevice

(

void

)

References DUNE::Hardware::UCTK::PKT_ID_RESET, sendFrame(), DUNE::Hardware::UCTK::Frame::setId(), and DUNE::Hardware::UCTK::Frame::setPayloadSize().

Referenced by DUNE::Hardware::UCTK::Bootloader::Bootloader(), and DUNE::Hardware::UCTK::Bootloader::~Bootloader().

bool DUNE::Hardware::UCTK::Interface::sendFrame	(	Frame &	frame,
		double	timeout = 1.0
	)

References DUNE::Hardware::UCTK::Frame::computeCRC(), DUNE::Hardware::UCTK::Frame::getData(), DUNE::Hardware::UCTK::Frame::getSize(), and write().

Referenced by DUNE::Hardware::UCTK::Bootloader::program(), resetDevice(), and setBootStop().

void DUNE::Hardware::UCTK::Interface::setBootStop

(

bool

value

)

References DUNE::Hardware::UCTK::PKT_ID_BOOT, sendFrame(), DUNE::Hardware::UCTK::Frame::set(), DUNE::Hardware::UCTK::Frame::setId(), and DUNE::Hardware::UCTK::Frame::setPayloadSize().

Referenced by DUNE::Hardware::UCTK::Bootloader::Bootloader(), and DUNE::Hardware::UCTK::Bootloader::~Bootloader().

void DUNE::Hardware::UCTK::Interface::write ( const uint8_t *  data, unsigned  data_size  )

inline

References doWrite().

Referenced by sendFrame().

Collaboration diagram for DUNE::Hardware::UCTK::Interface: