Display effect for showing the current date. More...

Inheritance diagram for JBWoprDateDisplayEffect:

Public Member Functions
	JBWoprDateDisplayEffect (JBWoprDevice *woprDevice, std::string dateFormat="", uint32_t duration=-1, const std::string &name=JBWOPR_EFFECT_NAME_DATE)
	Constructor.

void	start () override
	Start effect.

void	loop () override
	Get name of effect.

void	setDateFormat (const std::string &dateFormat)
	Set date format.

Public Member Functions inherited from JBWoprEffectBase
	JBWoprEffectBase (JBWoprDevice *woprDevice, uint32_t duration=-1, std::string name=JBWOPR_EFFECT_NAME_BASE)
	Constructor.

virtual std::string	getName ()
	Get name of effect.

virtual void	stop ()
	Stop effect.

bool	isRunning () const
	Check if effect is running.

uint32_t	getDuration () const
	Set duration of effect.

Protected Attributes
std::string	_rawTimeFormat
	Raw time format.

std::string	_timeFormatEven
	Time format for even.

std::string	_timeFormatOdd
	Time format for odd.

std::string	_rawDateFormat
	Raw date format.

std::string	_dateFormat
	Date format.

Protected Attributes inherited from JBWoprEffectBase
JBWoprDevice *	_woprDevice
	JBWoprDevice instance.

std::string	_name
	Name of effect.

bool	_isRunning = false
	True if effect is running.

bool	_done = true
	True if effect is done, waiting for duration to end.

uint32_t	_duration = -1
	Duration of effect in milliseconds.

uint32_t	_startTime = 0
	Start time of effect in milliseconds.

uint32_t	_nextTick = 0
	Next tick time in milliseconds.

Additional Inherited Members
Protected Member Functions inherited from JBWoprEffectBase
void	_displayText (const std::string &text, JBTextAlignment alignment=JBTextAlignment::LEFT)
	Display text on raw display.

Detailed Description

Display effect for showing the current date.

Constructor & Destructor Documentation

JBWoprDateDisplayEffect::JBWoprDateDisplayEffect	(	JBWoprDevice *	woprDevice,
		std::string	dateFormat = `""`,
		uint32_t	duration = `-1`,
		const std::string &	name = `JBWOPR_EFFECT_NAME_DATE`
	)

explicit

Constructor.

Parameters

woprDevice	JBWoprDevice instance
dateFormat	(optional) Date format, default is fetched from config
duration	(optional) Duration of effect in milliseconds, default is -1 (infinite)
name	(optional) Name of effect

void JBWoprDateDisplayEffect::loop ( )

overridevirtual

Get name of effect.

Reimplemented from JBWoprEffectBase.

void JBWoprDateDisplayEffect::setDateFormat ( const std::string & dateFormat )

Set date format.

Parameters

dateFormat Date format

void JBWoprDateDisplayEffect::start ( )

overridevirtual

Start effect.

Reimplemented from JBWoprEffectBase.

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