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

Base class for UsRangeFinder. More...

#include <UsRangeFinder.h>

+ Inheritance diagram for flair::sensor::UsRangeFinder:

Public Member Functions

 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
 
- 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...
 

Protected Member Functions

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...
 

Protected Attributes

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 }
 
- Public Attributes inherited from flair::core::IODevice
Time lastUpdate
 

Detailed Description

Base class for UsRangeFinder.

Use this class to define a custom UsRangeFinder.

Constructor & Destructor Documentation

flair::sensor::UsRangeFinder::UsRangeFinder ( const core::FrameworkManager parent,
std::string  name 
)

Constructor.

Construct a UsRangeFinder. Control part.

Parameters
parentparent
namename
flair::sensor::UsRangeFinder::UsRangeFinder ( const core::IODevice parent,
std::string  name 
)

Constructor.

Construct a UsRangeFinder. Simulation part.

Parameters
parentparent
namename
flair::sensor::UsRangeFinder::~UsRangeFinder ( )

Destructor.

Member Function Documentation

void flair::sensor::UsRangeFinder::LockUserInterface ( void  ) const

Lock user interface.

void flair::sensor::UsRangeFinder::UnlockUserInterface ( void  ) const

Unlock user interface.

void flair::sensor::UsRangeFinder::UseDefaultPlot ( void  )

Use default plot.

Should no be used for the simulation part.

gui::DataPlot1D* flair::sensor::UsRangeFinder::GetPlot ( void  ) const

Plot.

Returns
DataPlot1D
gui::Layout* flair::sensor::UsRangeFinder::GetLayout ( void  ) const

Setup Layout.

Returns
a Layout available
gui::Tab* flair::sensor::UsRangeFinder::GetPlotTab ( void  ) const

Plot tab.

Returns
plot Tab
float flair::sensor::UsRangeFinder::Value ( void  ) const

Value.

Returns
output value
gui::GroupBox* flair::sensor::UsRangeFinder::GetGroupBox ( void  ) const
protected

Setup GroupBox.

Returns
a GroupBox available

Member Data Documentation

core::cvmatrix* flair::sensor::UsRangeFinder::output
protected

Output matrix.

Returns
output matrix