LazyTrigger.h

Go to the documentation of this file.

/*
Copyright 2007-2026. Algoryx Simulation AB.
 
All AGX source code, intellectual property, documentation, sample code,
tutorials, scene files and technical white papers, are copyrighted, proprietary
and confidential material of Algoryx Simulation AB. You may not download, read,
store, distribute, publish, copy or otherwise disseminate, use or expose this
material unless having a written signed agreement with Algoryx Simulation AB, or having been
advised so by Algoryx Simulation AB for a time limited evaluation, or having purchased a
valid commercial license from Algoryx Simulation AB.
 
Algoryx Simulation AB disclaims all responsibilities for loss or damage caused
from using this software, unless otherwise stated in written agreements with
Algoryx Simulation AB.
*/
#pragma once
#include <agx/Integer.h>
 
#include <atomic>
 
#ifndef SWIG
namespace agxSensor
{
  class LazyTrigger final
  {
    public:
      inline LazyTrigger(bool triggerInitially = false)
        : m_triggerState {static_cast<agx::UInt8>(triggerInitially ? 2u : 0u)}
      {
      }
 
      LazyTrigger(const LazyTrigger&) = delete;
 
      LazyTrigger& operator=(const LazyTrigger&) = delete;
 
    public:
      inline bool shouldTrigger() const noexcept { return m_triggerState > 0u; }
 
      inline operator bool() const noexcept { return shouldTrigger(); }
 
      inline void trigger()
      {
        auto value = m_triggerState.load();
        while (value < 2u)
          m_triggerState.compare_exchange_weak(value, 2u, std::memory_order_relaxed);
      }
 
      inline void flagTriggered()
      {
        auto value = m_triggerState.load();
        while (value > 1u)
          m_triggerState.compare_exchange_weak(value, 1u, std::memory_order_relaxed);
      }
 
      inline void softResetTrigger()
      {
        auto value = m_triggerState.load();
        while (value == 1u)
          m_triggerState.compare_exchange_weak(value, 0u, std::memory_order_relaxed);
      }
 
      inline void hardResetTrigger() { m_triggerState = 0u; }
 
    private:
      std::atomic<agx::UInt8> m_triggerState;
  };
}
#endif