flair::sensor::BatteryMonitor Class Reference

Base class for battery monitor. More...

#include <BatteryMonitor.h>

Inheritance diagram for flair::sensor::BatteryMonitor:

Public Member Functions
	BatteryMonitor (const gui::LayoutPosition *position, std::string name)
	Constructor. More...
	~BatteryMonitor ()
	Destructor. More...
bool	IsBatteryLow (void)
	Is batteru low? More...
void	SetBatteryValue (float value)
	Set battery value. More...
float	GetVoltage (void) const
	Get battery voltage. More...
Public Member Functions inherited from flair::gui::GroupBox
	GroupBox (const LayoutPosition *position, std::string name)
	Constructor. More...
	~GroupBox ()
	Destructor. More...
Public Member Functions inherited from flair::gui::Layout
	Layout (const Widget *parent, std::string name, std::string type)
	Constructor. More...
	~Layout ()
	Destructor. More...
LayoutPosition *	LastRowLastCol (void) const
	Last Row and Col LayoutPosition. More...
LayoutPosition *	NewRow (void) const
	New Row LayoutPosition. More...
LayoutPosition *	At (uint16_t row, uint16_t col) const
	LayoutPosition at specified position. More...
Public Member Functions inherited from flair::gui::Widget
	Widget (const Widget *parent, std::string name, std::string type)
	Constructor. More...
virtual	~Widget ()
	Destructor. More...
void	setEnabled (bool status)
	Set enabled. More...
bool	isEnabled (void) const
	Is enabled? 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 Object *	Parent (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 }
Protected Member Functions inherited from flair::gui::Widget
template<typename T >
void	SetPersistentXmlProp (std::string prop, T value)
	Set a persistent xml property. More...
template<typename T >
bool	GetPersistentXmlProp (std::string prop, T &value)
	Get a persistent xml property. More...
template<typename T >
void	SetVolatileXmlProp (std::string prop, T value, xmlNodePtr node=NULL)
	Set a volatile xml property. More...
void	SendXml (void)
	Send xml. More...
virtual void	XmlEvent (void)
	Xml event. More...
void	UnsetPersistentXmlProp (std::string prop)
	Unset a persistent xml property. More...

Detailed Description

Base class for battery monitor.

Constructor & Destructor Documentation

flair::sensor::BatteryMonitor::BatteryMonitor	(	const gui::LayoutPosition *	position,
		std::string	name
	)

Constructor.

Construct a BatteryMonitor at given position.

Parameters

position	position
name	name

flair::sensor::BatteryMonitor::~BatteryMonitor

(

)

Destructor.

Member Function Documentation

bool flair::sensor::BatteryMonitor::IsBatteryLow

(

void

)

Is batteru low?

Returns

true if battery is below threshold

void flair::sensor::BatteryMonitor::SetBatteryValue

(

float

value

)

Set battery value.

Parameters

battery

value

float flair::sensor::BatteryMonitor::GetVoltage

(

void

)

const

Get battery voltage.

Returns

battery voltage