Utility::ToggleLightsEvent Class Reference

#include <toggle_lights_event.h>

Inheritance diagram for Utility::ToggleLightsEvent:

Public Member Functions
	ToggleLightsEvent (const bool on)
	ToggleLightsEvent constructor. More...
bool	turnOn () const noexcept
	Turn the lights on? More...
Public Member Functions inherited from Events::Event
	Event (const EventType &type)
	Event constructor. More...
EventType	getEventType () const
	Gets the event type. More...

Static Public Member Functions
static std::shared_ptr < ToggleLightsEvent >	create (const bool on)
	Factory function. More...

Constructor & Destructor Documentation

Utility::ToggleLightsEvent::ToggleLightsEvent ( const bool  on )

inline

ToggleLightsEvent constructor.

Parameters

[in]

on

Turn the lights on?

Member Function Documentation

static std::shared_ptr<ToggleLightsEvent> Utility::ToggleLightsEvent::create ( const bool  on )

inlinestatic

Factory function.

Parameters

[in]

on

Turn the lights on?

Returns

newly created TogglLightsEvent

Referenced by generated::getToggleLightsEventModule(), and Utility::DebugParser::parseCommand().

bool Utility::ToggleLightsEvent::turnOn ( ) const

inlinenoexcept

Turn the lights on?

Returns

True if yes

Referenced by generated::getToggleLightsEventModule().

---

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

• src/utility/toggle_lights_event.h