An element for scheduling new events. More...

#include <xronos/sdk/programmable_timer.hh>

Inheritance diagram for xronos::sdk::ProgrammableTimer< void >:

Public Member Functions
	ProgrammableTimer (std::string_view name, ReactorContext context)
	Construct a new `ProgrammableTimer`.

	ProgrammableTimer (std::string_view name, ReactorContext context)
	Construct a new `ProgrammableTimer`.

Public Member Functions inherited from xronos::sdk::Element
auto	name () const noexcept -> const std::string &
	The name of the current element.

auto	fqn () const noexcept -> const std::string &
	The fully qualified name of the current element.

Public Member Functions inherited from xronos::sdk::EventSource< void >
virtual	~EventSource ()=default
	Correct deletion of an instance of a derived class is permitted.

virtual	~EventSource ()=default
	Correct deletion of an instance of a derived class is permitted.

Detailed Description

An element for scheduling new events.

Programmable timers may be used by reactions to schedule new events in the future. Events are not scheduled or read directly. Instead, reactions may declare a BaseReaction::ProgrammableTimerEffect to schedule new events, or a BaseReaction::Trigger or BaseReaction::Source to access the value associated with an active event.

This specialization is used for programmable timers that do not convey any values.

Constructor & Destructor Documentation

◆ ProgrammableTimer() [1/2]

xronos::sdk::ProgrammableTimer< void >::ProgrammableTimer	(	std::string_view	name,
		ReactorContext	context )

Construct a new ProgrammableTimer.

Parameters

name	The name of the `ProgrammableTimer`.
context	The context object obtained from the `ProgrammableTimer`'s containing reactor.

◆ ProgrammableTimer() [2/2]

xronos::sdk::ProgrammableTimer< void >::ProgrammableTimer	(	std::string_view	name,
		ReactorContext	context )