RTOS Wrapper
API reference
Loading...
Searching...
No Matches
Public Member Functions | List of all members
hf::FlagsWriter< FlagId, kCount > Class Template Referenceabstract

Write-side ABC for FlagsSaver. More...

#include <FlagsSaver.h>

Inheritance diagram for hf::FlagsWriter< FlagId, kCount >:
hf::FlagsSaver< FlagId, kCount >

Public Member Functions

virtual ~FlagsWriter () noexcept=default
 
virtual bool Set (FlagId id, uint32_t now_ms=0) noexcept=0
 Mark id set. Idempotent: returns false if state was already Set (no event signalled).
 
virtual bool Clear (FlagId id, uint32_t now_ms=0) noexcept=0
 Mark id cleared. Idempotent: returns false if state was already Cleared (no event signalled).
 
virtual bool ClearAll (uint32_t now_ms=0) noexcept=0
 Reset every slot to Cleared and signal a change.
 

Detailed Description

template<typename FlagId, std::size_t kCount>
class hf::FlagsWriter< FlagId, kCount >

Write-side ABC for FlagsSaver.

Constructor & Destructor Documentation

◆ ~FlagsWriter()

template<typename FlagId , std::size_t kCount>
virtual hf::FlagsWriter< FlagId, kCount >::~FlagsWriter ( )
virtualdefaultnoexcept

Member Function Documentation

◆ Clear()

template<typename FlagId , std::size_t kCount>
virtual bool hf::FlagsWriter< FlagId, kCount >::Clear ( FlagId  id,
uint32_t  now_ms = 0 
)
pure virtualnoexcept

Mark id cleared. Idempotent: returns false if state was already Cleared (no event signalled).

Implemented in hf::FlagsSaver< FlagId, kCount >.

◆ ClearAll()

template<typename FlagId , std::size_t kCount>
virtual bool hf::FlagsWriter< FlagId, kCount >::ClearAll ( uint32_t  now_ms = 0)
pure virtualnoexcept

Reset every slot to Cleared and signal a change.

Implemented in hf::FlagsSaver< FlagId, kCount >.

◆ Set()

template<typename FlagId , std::size_t kCount>
virtual bool hf::FlagsWriter< FlagId, kCount >::Set ( FlagId  id,
uint32_t  now_ms = 0 
)
pure virtualnoexcept

Mark id set. Idempotent: returns false if state was already Set (no event signalled).

Parameters
now_msOptional timestamp recorded as LastChangeMs() when the bit actually transitioned. Pass 0 to skip.

Implemented in hf::FlagsSaver< FlagId, kCount >.


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