libnifalcon::FalconDeviceBoostThread Class Reference
[Utility Classes]

#include <FalconDeviceBoostThread.h>

Inherits libnifalcon::FalconDevice.

Collaboration diagram for libnifalcon::FalconDeviceBoostThread:

Collaboration graph
[legend]

List of all members.

Public Member Functions

 FalconDeviceBoostThread ()
virtual ~FalconDeviceBoostThread ()
void startThread ()
virtual void runThreadLoop ()
void stopThread ()
bool isThreadRunning ()
void getPosition (boost::array< double, 3 > &pos)

Protected Member Functions

void runDeviceComm ()

Protected Attributes

boost::shared_ptr< boost::thread > m_ioThread
boost::array< double, 3 > m_localPosition
bool m_runThreadLoop


Detailed Description

The FalconDeviceBoostThread class is a sample device that uses the boost::thread class to run the communications loop to the falcon.

The FalconDeviceBoostThread class is only available if the boost::thread library is available on the system.


Constructor & Destructor Documentation

libnifalcon::FalconDeviceBoostThread::FalconDeviceBoostThread (  ) 

Constructor

libnifalcon::FalconDeviceBoostThread::~FalconDeviceBoostThread (  )  [virtual]

Destructor


Member Function Documentation

void libnifalcon::FalconDeviceBoostThread::getPosition ( boost::array< double, 3 > &  pos  ) 

Thread safe position return

bool libnifalcon::FalconDeviceBoostThread::isThreadRunning (  )  [inline]

Thread run status

Returns:
True if running, false otherwise

void libnifalcon::FalconDeviceBoostThread::runDeviceComm (  )  [protected]

Wrapper function for dealing with device communication

void libnifalcon::FalconDeviceBoostThread::runThreadLoop (  )  [virtual]

Runs IO loop. Overridden to implement application specific functionality

void libnifalcon::FalconDeviceBoostThread::startThread (  ) 

Starts a thread that runs FalconDevice::runIOLoop constantly

void libnifalcon::FalconDeviceBoostThread::stopThread (  ) 

Stops thread if running


Member Data Documentation

boost::shared_ptr<boost::thread> libnifalcon::FalconDeviceBoostThread::m_ioThread [protected]

Internal thread object

boost::array<double, 3> libnifalcon::FalconDeviceBoostThread::m_localPosition [protected]

Internal position storage

Internal thread execution state. Thread loop exits if this is false.


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

Generated on Sun Sep 20 12:24:32 2009 for libnifalcon by  doxygen 1.5.9