ot::Bird Class Reference

This class is a datatype helper class for the FOBModule class. More...

Collaboration diagram for ot::Bird:


Public Member Functions
	Bird (int number_, const std::string &device_, float scale_, float *anglealign_=NULL)
void	convert ()
void	convert (const char *buffer)
int	parse (const char *buffer, int len, int framesize)
int	open ()
int	write (const char *data, int count)
int	read (char *data, int count)
int	close ()
int	reset ()
int	setGroupMode (const bool value)
int	getErrorCode ()
int	autoConfig (const int number)
void	sleep ()
void	setReportMode (const int toBird=-1)
void	setScale (const int scale, const int toBird=-1)
void	setXYZFrame (const bool useFrame, const int toBird=-1)
void	setHemisphere (const FOBModule::Hemisphere hemisphere, const int toBird=-1)
void	setAngleAlign (const float *angles, const int toBird=-1)
void	setReferenceFrame (const float *angles, const int toBird=-1)
int	sendReset ()
Public Attributes
int	number
SerialPort	port
char	buffer [20]
int	count
FOBSource *	source
Event	event
bool	newVal
float	scale
float	angleAlign [3]
Static Public Attributes
static const float	inchesToMeters = 0.0254f

Detailed Description

This class is a datatype helper class for the FOBModule class.

It stores the relevant data for a single bird station and provides buffer storage and conversion routines.

Author:: Thomas Peterseil

Definition at line 70 of file FOBModule.cxx.

Constructor & Destructor Documentation

ot::Bird::Bird	(	int	number_,
		const std::string &	device_,
		float	scale_,
		float *	anglealign_ = `NULL`
	)			`[inline]`

constructor

Definition at line 104 of file FOBModule.cxx.

References angleAlign, count, event, ot::Event::getConfidence(), inchesToMeters, newVal, SerialPort::pathname, port, scale, and source.

Member Function Documentation

int ot::Bird::autoConfig ( const int number ) [inline]

Definition at line 919 of file FOBModule.cxx.

References buffer, getErrorCode(), ot::OSUtils::sleep(), and write().

Referenced by ot::FOBModule::initFoB().

int ot::Bird::close ( ) [inline]

closes the serial port associated with the bird.

Returns:: the error value from the serial library.

Definition at line 878 of file FOBModule.cxx.

References closeSerialPort(), and port.

void ot::Bird::convert ( const char * buffer ) [inline]

converts data from another buffer and writes it to the local event member.

It assumes that data is in the POSITION/QUATERNION format.

Parameters:

buffer

pointer to the char buffer storing the input data.

Definition at line 802 of file FOBModule.cxx.

References event, ot::Event::getOrientation(), ot::Event::getPosition(), scale, and ot::Event::timeStamp().

void ot::Bird::convert ( ) [inline]

converts the buffer data and writes it to the local event member

Definition at line 797 of file FOBModule.cxx.

References buffer.

int ot::Bird::getErrorCode ( ) [inline]

Definition at line 901 of file FOBModule.cxx.

References buffer, count, read(), ot::OSUtils::sleep(), and write().

Referenced by autoConfig(), sendReset(), and setGroupMode().

int ot::Bird::open ( ) [inline]

opens the serial port associated with the bird.

Returns:: the error value from the serial library.

Definition at line 853 of file FOBModule.cxx.

References SerialParams::baudrate, SerialParams::bits, SerialParams::blocking, SerialParams::hwflow, initSerialParams(), openSerialPort(), SerialParams::parity, SerialPort::pathname, SerialParams::pathname, port, SerialParams::sbit, and SerialParams::swflow.

int ot::Bird::parse	(	const char *	buffer,
		int	len,
		int	framesize
	)			`[inline]`

reads data from an input buffer into the internal buffer.

this method looks for the phasing bit and then starts to read in data until the input buffer ends, or it has read a whole frame. If the frame is completed it sets the flag newVal to true.

Parameters: