Flair
Framework Libre Air
flair::sensor::VrpnClient Class Reference

Class to connect to a Vrpn server. The Thread is created with the FrameworkManager as parent. FrameworkManager must be created before. Only one instance of this class is allowed by program. More...

#include <VrpnClient.h>

+ Inheritance diagram for flair::sensor::VrpnClient:

Public Member Functions

 VrpnClient (std::string name, std::string address, uint8_t priority)
 Constructor. More...
 
 VrpnClient (std::string name, core::SerialPort *serialport, uint16_t us_period, uint8_t priority)
 Constructor. More...
 
 ~VrpnClient ()
 Destructor. More...
 
gui::LayoutGetLayout (void) const
 Setup Layout. More...
 
gui::TabWidgetGetTabWidget (void) const
 Setup Tab. More...
 
bool UseXbee (void) const
 Is XBee used? More...
 
- Public Member Functions inherited from flair::core::Thread
 Thread (const Object *parent, std::string name, uint8_t priority, uint32_t stackSize=1024 *128)
 Constructor. More...
 
virtual ~Thread ()
 Destructor. More...
 
void Start (void)
 Start the thread. More...
 
void SafeStop (void)
 Set a stop flag. More...
 
bool ToBeStopped (void) const
 Set a stop flag. More...
 
void Join (void)
 Join the thread. More...
 
void SetPeriodUS (uint32_t period_us)
 Set the period in micro second. More...
 
uint32_t GetPeriodUS () const
 
void SetPeriodMS (uint32_t period_ms)
 Set the period in milli second. More...
 
uint32_t GetPeriodMS () const
 
bool IsPeriodSet (void)
 Returns if period was set. More...
 
void WaitPeriod (void) const
 Wait the period. More...
 
int WaitUpdate (const IODevice *device)
 Wait update of an IODevice. More...
 
void Suspend (void)
 Suspend the thread. More...
 
bool SuspendUntil (Time date)
 Suspend the thread with timeout. More...
 
void Resume (void)
 Resume the thread. More...
 
bool IsSuspended (void) const
 Is the thread suspended? More...
 
bool IsRunning (void) const
 Is the thread running? More...
 
void SleepUntil (Time time) const
 Sleep until absolute time. More...
 
void SleepUS (uint32_t time_us) const
 Sleep for a certain time in micro second. More...
 
void SleepMS (uint32_t time_ms) const
 Sleep for a cartain time in milli second. More...
 
- Public Member Functions inherited from flair::core::Object
 Object (const Object *parent=NULL, std::string name="", std::string type="")
 Constructor. More...
 
virtual ~Object ()
 Destructor. More...
 
std::string ObjectName (void) const
 Name. More...
 
std::string ObjectType (void) const
 Type. More...
 
const ObjectParent (void) const
 Parent. More...
 
std::vector< const Object * > * TypeChilds (void) const
 Childs of the same type. More...
 
std::vector< const Object * > * Childs (void) const
 Childs. More...
 
void Information (const char *function, int line, const char *format,...) const
 Formatted information. More...
 
void Warning (const char *function, const char *format,...) const
 Formatted warning. More...
 
void Error (const char *function, const char *format,...) const
 Formatted error. More...
 
bool ErrorOccured (bool recursive=true) const
 Has an errror occured? More...
 

Additional Inherited Members

- Public Types inherited from flair::core::Object
enum  color_t { Auto = 0, Red = 31, Green = 32, Orange = 33 }
 
- Static Public Member Functions inherited from flair::core::Thread
static void WarnUponSwitches (bool enable)
 Warn if real time / non real time switches occur. More...
 

Detailed Description

Class to connect to a Vrpn server. The Thread is created with the FrameworkManager as parent. FrameworkManager must be created before. Only one instance of this class is allowed by program.

Constructor & Destructor Documentation

flair::sensor::VrpnClient::VrpnClient ( std::string  name,
std::string  address,
uint8_t  priority 
)

Constructor.

Construct a VrpnClient. Connection is done by IP.

Parameters
namename
addressserver address
prioritypriority of the Thread
flair::sensor::VrpnClient::VrpnClient ( std::string  name,
core::SerialPort serialport,
uint16_t  us_period,
uint8_t  priority 
)

Constructor.

Construct a VrpnClient. Connection is done by XBee modem.

Parameters
namename
serialportSerialPort for XBee modem
us_periodXbee RX timeout in us
prioritypriority of the Thread
flair::sensor::VrpnClient::~VrpnClient ( )

Destructor.

Member Function Documentation

gui::Layout* flair::sensor::VrpnClient::GetLayout ( void  ) const

Setup Layout.

Returns
a Layout available
gui::TabWidget* flair::sensor::VrpnClient::GetTabWidget ( void  ) const

Setup Tab.

Returns
a Tab available
bool flair::sensor::VrpnClient::UseXbee ( void  ) const

Is XBee used?

Returns
true if connection is based on XBee modem