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

Class for a simulation UsRangeFinder. More...

#include <SimuLaser.h>

+ Inheritance diagram for flair::sensor::SimuUs:

Public Member Functions

 SimuUs (const core::FrameworkManager *parent, std::string name, uint32_t dev_id, uint8_t priority)
 Constructor. More...
 
 SimuUs (const core::IODevice *parent, std::string name, uint32_t dev_id)
 Constructor. More...
 
 ~SimuUs ()
 Destructor. More...
 
- Public Member Functions inherited from flair::core::Thread
 Thread (const Object *parent, std::string name, uint8_t priority)
 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...
 
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...
 
- Public Member Functions inherited from flair::sensor::UsRangeFinder
 UsRangeFinder (const core::FrameworkManager *parent, std::string name)
 Constructor. More...
 
 UsRangeFinder (const core::IODevice *parent, std::string name)
 Constructor. More...
 
 ~UsRangeFinder ()
 Destructor. More...
 
void LockUserInterface (void) const
 Lock user interface. More...
 
void UnlockUserInterface (void) const
 Unlock user interface. More...
 
void UseDefaultPlot (void)
 Use default plot. More...
 
gui::DataPlot1DGetPlot (void) const
 Plot. More...
 
gui::LayoutGetLayout (void) const
 Setup Layout. More...
 
gui::TabGetPlotTab (void) const
 Plot tab. More...
 
float Value (void) const
 Value. More...
 
- Public Member Functions inherited from flair::core::IODevice
 IODevice (const Object *parent, std::string name)
 Constructor. More...
 
virtual ~IODevice ()
 Destructor. More...
 
void AddDeviceToLog (const IODevice *device)
 Add an IODevice to the logs. More...
 
void AddDataToLog (const io_data *data)
 Add an io_data to the log. More...
 
void OutputToShMem (bool enabled)
 Send the output to a shared memory. More...
 
virtual DataType const & GetInputDataType () const
 
virtual DataType const & GetOutputDataType () const
 

Protected Attributes

core::SharedMemshmem
 SharedMem to access datas. More...
 
- Protected Attributes inherited from flair::sensor::UsRangeFinder
core::cvmatrixoutput
 Output matrix. 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...
 
- Public Attributes inherited from flair::core::IODevice
Time lastUpdate
 
- Protected Member Functions inherited from flair::sensor::UsRangeFinder
gui::GroupBoxGetGroupBox (void) const
 Setup GroupBox. More...
 
- Protected Member Functions inherited from flair::core::IODevice
void ProcessUpdate (io_data *data)
 Process the childs of type IODevice, and log if needed. More...
 

Detailed Description

Class for a simulation UsRangeFinder.

Constructor & Destructor Documentation

flair::sensor::SimuUs::SimuUs ( const core::FrameworkManager parent,
std::string  name,
uint32_t  dev_id,
uint8_t  priority 
)

Constructor.

Construct a SimuUs. Control part.

Parameters
parentparent
namename
dev_iddevice id
prioritypriority of the Thread
flair::sensor::SimuUs::SimuUs ( const core::IODevice parent,
std::string  name,
uint32_t  dev_id 
)

Constructor.

Construct a SimuUs. Simulation part.
The Thread of this class should not be run.

Parameters
parentparent
namename
dev_iddevice id
flair::sensor::SimuUs::~SimuUs ( )

Destructor.

Member Data Documentation

core::SharedMem* flair::sensor::SimuUs::shmem
protected

SharedMem to access datas.