JBWoprTimeDisplayEffect Class Reference

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

#include <jbwopreffects.h>

Inheritance diagram for JBWoprTimeDisplayEffect:

Public Member Functions
	JBWoprTimeDisplayEffect (JBWoprDevice *woprDevice, std::string timeFormat="", uint32_t duration=-1, const std::string &name=JBWOPR_EFFECT_NAME_TIME)
	Constructor.
void	start () override
	Start effect.
void	loop () override
	Run loop.
virtual void	setTimeFormat (const std::string &timeFormat)
	Set time 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 Member Functions
virtual std::string	_getOddTimeFormat (const std::string &format)
	Get time format.
Protected Member Functions inherited from JBWoprEffectBase
void	_displayText (const std::string &text, JBTextAlignment alignment=JBTextAlignment::LEFT)
	Display text on raw display.

Protected Attributes
bool	_evenFormat = false
	True if even format.
std::string	_rawTimeFormat
	Raw time format.
std::string	_timeFormatEven
	Time format for even.
std::string	_timeFormatOdd
	Time format for odd.
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.

Detailed Description

Display effect for showing the current time.

Constructor & Destructor Documentation

JBWoprTimeDisplayEffect()

JBWoprTimeDisplayEffect::JBWoprTimeDisplayEffect ( JBWoprDevice * woprDevice, std::string timeFormat = "", uint32_t duration = -1, const std::string & name = JBWOPR_EFFECT_NAME_TIME )

explicit

Constructor.

Parameters

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

Member Function Documentation

_getOddTimeFormat()

std::string JBWoprTimeDisplayEffect::_getOddTimeFormat ( const std::string & format )

protectedvirtual

Get time format.

Parameters

format

Returns

Time format

loop()

void JBWoprTimeDisplayEffect::loop ( )

overridevirtual

Run loop.

Reimplemented from JBWoprEffectBase.

Reimplemented in JBWoprTimeDisplayRainbowEffect.

setTimeFormat()

void JBWoprTimeDisplayEffect::setTimeFormat ( const std::string & timeFormat )

virtual

Set time format.

Parameters

timeFormat

Time format

start()

void JBWoprTimeDisplayEffect::start ( )

overridevirtual

Start effect.

Reimplemented from JBWoprEffectBase.

---

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

• src/effects/jbwopreffects.h
• src/effects/jbwopreffects.cpp