rec::robotino::api2::NorthStar Class Reference

Represents the NorthStar tracking device. More...

#include <NorthStar.h>

Inheritance diagram for rec::robotino::api2::NorthStar:

Public Member Functions
void	setComId (const ComId &id)
void	setRoomId (unsigned int room)
void	setCeilingCal (float ceilingCal)
NorthStarReadings	readings () const
virtual void	readingsEvent (const NorthStarReadings &readings)
Public Member Functions inherited from rec::robotino::api2::ComObject
	ComObject ()
virtual	~ComObject ()
ComId	comId () const

Friends
class	NorthStarImpl

Additional Inherited Members
Protected Attributes inherited from rec::robotino::api2::ComObject
ComId	_comID

Detailed Description

Represents the NorthStar tracking device.

Member Function Documentation

NorthStarReadings rec::robotino::api2::NorthStar::readings

(

)

const

Get the current readings.

Returns

The latest readings.

Exceptions

nothing

Remarks

This function is thread save

virtual void rec::robotino::api2::NorthStar::readingsEvent ( const NorthStarReadings &  readings )

virtual

Called when new data is available.

Parameters

readings

The sensor readings.

Remarks

This function is called from the thread in which Com::processEvents() is called.

See also

Com::processEvents

void rec::robotino::api2::NorthStar::setCeilingCal

(

float

ceilingCal

)

Set the ceiling calibration.

Parameters

ceilingCal

The distance from sensor to ceiling (or wherever the projector is projecting its pattern to) in meters.

Exceptions

RobotinoException

if given id is invalid.

Remarks

This function is thread save

void rec::robotino::api2::NorthStar::setComId

(

const ComId &

id

)

Sets the associated communication object.

Parameters

id	The id of the associated communication object.

Exceptions

RobotinoException

if given id is invalid.

Remarks

This function is thread save

void rec::robotino::api2::NorthStar::setRoomId

(

unsigned int

room

)

Set the room id.

Parameters

room	The id of the room northstar is in.

Exceptions

RobotinoException

if given id is invalid.

Remarks

This function is thread save

---

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

• C:/srcs/git/openrobotino/api2/lib/rec/robotino/api2/NorthStar.h