rec::robotino::api2 C++ interface
Public Member Functions | Friends | List of all members
rec::robotino::api2::Pose Class Reference

Represents Robotino's odoemtry module. More...

#include <Pose.h>

Inheritance diagram for rec::robotino::api2::Pose:
rec::robotino::api2::ComObject

Public Member Functions

 Pose (const ComId &id)
 
void setComId (const ComId &id)
 
void readings (double *x, double *y, double *phi, double *errx=0, double *erry=0, double *errphi=0, unsigned int *sequence=0) const
 
virtual void readingsEvent (double x, double y, double phi, double errx, double erry, double errphi, unsigned int sequence)
 
- Public Member Functions inherited from rec::robotino::api2::ComObject
 ComObject ()
 
virtual ~ComObject ()
 
ComId comId () const
 

Friends

class PoseImpl
 

Additional Inherited Members

- Protected Attributes inherited from rec::robotino::api2::ComObject
ComId _comID
 

Detailed Description

Represents Robotino's odoemtry module.

Member Function Documentation

void rec::robotino::api2::Pose::readings ( double *  x,
double *  y,
double *  phi,
double *  errx = 0,
double *  erry = 0,
double *  errphi = 0,
unsigned int *  sequence = 0 
) const
Parameters
xGlobal corrected x position of Robotino in m.
yGlobal corrected y position of Robotino in m.
phiGlobal corrected orientation of Robotino in rad.
errxError in x direction.
erryError in y direction.
errphiError of orientation.
sequenceThe sequence number of the current readings. When starting your application the sequence number is 0. The sequence number is increased 1 each time the Pose is updated.
Exceptions
nothing.
Remarks
This function is thread save
virtual void rec::robotino::api2::Pose::readingsEvent ( double  x,
double  y,
double  phi,
double  errx,
double  erry,
double  errphi,
unsigned int  sequence 
)
virtual

Called when new Pose data is available.

Parameters
xGlobal x position of Robotino in m.
yGlobal y position of Robotino in m.
phiGlobal orientation of Robotino in rad.
vxx velocity of Robotino.
vyy velocity of Robotino.
omegaAngular velocity of Robotino.
sequenceThe sequence number of the current readings. When starting your application the sequence number is 0. The sequence number is increased 1 each time the Pose is updated.
Remarks
This function is called from the thread in which Com::processEvents() is called.
See also
Com::processEvents
void rec::robotino::api2::Pose::setComId ( const ComId id)

Sets the associated communication object.

Parameters
idThe id of the associated communication object.
Exceptions
RobotinoExceptionif given id is invalid.
Remarks
This function is thread save

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