Sygaldry
Loading...
Searching...
No Matches
sygaldry::bng< name_str, desc, Tags > Struct Template Reference

A semantically value-less endpoint that signals an event. More...

Inheritance diagram for sygaldry::bng< name_str, desc, Tags >:
sygaldry::persistent< bool > sygaldry::name_< name_str > sygaldry::description_<""> sygaldry::tagged_< Tags... >

Public Types

enum  { bang , impulse }
 
- Public Types inherited from sygaldry::persistent< bool >
using type = bool
 The underlying type.
 

Public Member Functions

void operator() ()
 
void reset ()
 
- Public Member Functions inherited from sygaldry::persistent< bool >
constexpr persistent () noexcept
 Default constuctor defers to T's empty initializer.
 
constexpr persistent (bool &&t) noexcept
 Move constructor from T
 
constexpr persistent (const bool &t) noexcept
 Copy constructor from T
 
constexpr auto & operator= (bool &&t) noexcept
 Move assignment from T
 
constexpr auto & operator= (const bool &t) noexcept
 Copy assignment from T
 
constexpr operator bool & () noexcept
 Conversion to a mutable reference to the underlying value.
 
constexpr operator const bool & () const noexcept
 Conversion to a constant reference to the underlying value.
 

Additional Inherited Members

- Static Public Member Functions inherited from sygaldry::name_< name_str >
static _consteval auto name ()
 
- Static Public Member Functions inherited from sygaldry::description_<"">
static _consteval auto description ()
 
- Public Attributes inherited from sygaldry::persistent< bool >
bool value
 The wrapped value.
 

Detailed Description

template<string_literal name_str, string_literal desc = "", typename ... Tags>
struct sygaldry::bng< name_str, desc, Tags >

A semantically value-less endpoint that signals an event.

Example: bng<"falling edge", "indicates button state falling edge event"> falling_edge;

Template Parameters
name_strThe name of the endpoint. Required.
descA description of the endpoint. Defaults to an empty string.
TagsTag helper classes to apply to the endpoint. None by default.

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