irsol::camera::StatusMonitor Class Reference

Class that offers an easy way to run a background monitorin thread that periodically inspects and reports information about the camera interface passed as argument. More...

#include <monitor.hpp>

Public Member Functions
	StatusMonitor (const Interface &cam, irsol::types::duration_t monitorInterval=std::chrono::milliseconds(100))
	Constructs a StatusMonitor for the given camera interface.
	~StatusMonitor ()
	Destructor stops the monitoring thread if running.
void	start ()
	Starts the monitoring thread. If the monitor is already running, this call has no effect.
void	stop ()
	Stops the monitoring thread and waits for it to finish. If the monitor is not running, this call has no effect.

Protected Member Functions
virtual void	runMonitor () const
	The main monitoring loop executed on the background thread.

Private Attributes
const irsol::camera::Interface &	m_cam
	Reference to the camera interface being monitored.
irsol::types::duration_t	m_monitorInterval
	Interval at which the monitor thread executes runMonitor()
std::atomic< bool >	m_hasStartedMonitor
	Flag indicating if the monitor thread has been started.
std::thread	m_monitorThread
	Thread running the periodic monitoring loop.

Detailed Description

Class that offers an easy way to run a background monitorin thread that periodically inspects and reports information about the camera interface passed as argument.

See also

irsol::camera::Interface

Check out 01-loading-images for an example usage.

Definition at line 43 of file monitor.hpp.

Constructor & Destructor Documentation

StatusMonitor()

irsol::camera::StatusMonitor::StatusMonitor	(	const Interface &	cam,
		irsol::types::duration_t	monitorInterval = std::chrono::milliseconds(100)
	)

Constructs a StatusMonitor for the given camera interface.

Parameters

cam	Reference to the camera interface to monitor.
monitorInterval	Interval at which the monitoring task should run. Defaults to 100ms.

Definition at line 9 of file monitor.cpp.

  : m_cam(cam), m_monitorInterval(monitorInterval), m_hasStartedMonitor(false)
{
  IRSOL_ASSERT_ERROR(cam.isConnected(), "Camera is not connected.");
}

~StatusMonitor()

irsol::camera::StatusMonitor::~StatusMonitor

(

)

Destructor stops the monitoring thread if running.

Definition at line 15 of file monitor.cpp.

{
  if(m_hasStartedMonitor) {
    IRSOL_NAMED_LOG_DEBUG("status_monitor", "Automatic stopping monitoring of camera.");
    stop();
  }
}

Member Function Documentation

runMonitor()

void irsol::camera::StatusMonitor::runMonitor ( ) const

protectedvirtual

The main monitoring loop executed on the background thread.

Override this method in derived classes to implement specific monitoring logic. It is called repeatedly with the frequency specified by monitorInterval.

Definition at line 24 of file monitor.cpp.

{
  IRSOL_NAMED_LOG_DEBUG("status_monitor", "Monitoring camera status...");
 
  while(m_hasStartedMonitor) {
    auto nextIterationTime = irsol::types::clock_t::now() + m_monitorInterval;
 
    bool stopRequested = false;
    IRSOL_NAMED_LOG_INFO("status_monitor", "\n{}", m_cam.cameraStatusAsString());
    if(stopRequested) {
      break;
    }
 
    std::this_thread::sleep_until(nextIterationTime);
  }
}

start()

void irsol::camera::StatusMonitor::start

(

)

Starts the monitoring thread. If the monitor is already running, this call has no effect.

Definition at line 42 of file monitor.cpp.

{
  IRSOL_ASSERT_ERROR(!m_hasStartedMonitor.load(), "Monitor is already running!");
  m_hasStartedMonitor.store(true);
 
  m_monitorThread = std::thread([this]() { runMonitor(); });
  IRSOL_NAMED_LOG_DEBUG("status_monitor", "Camera monitor has started.");
}

stop()

void irsol::camera::StatusMonitor::stop

(

)

Stops the monitoring thread and waits for it to finish. If the monitor is not running, this call has no effect.

Definition at line 52 of file monitor.cpp.

{
  IRSOL_ASSERT_ERROR(
    m_hasStartedMonitor.load(), "Cannot 'stop' monitor without having started it before!");
  m_hasStartedMonitor.store(false);
 
  if(m_monitorThread.joinable()) {
    m_monitorThread.join();
  }
  IRSOL_NAMED_LOG_DEBUG("status_monitor", "Camera monitor has stopped.");
}

Member Data Documentation

m_cam

const irsol::camera::Interface& irsol::camera::StatusMonitor::m_cam

private

Reference to the camera interface being monitored.

Definition at line 83 of file monitor.hpp.

m_hasStartedMonitor

std::atomic<bool> irsol::camera::StatusMonitor::m_hasStartedMonitor

private

Flag indicating if the monitor thread has been started.

Definition at line 89 of file monitor.hpp.

m_monitorInterval

irsol::types::duration_t irsol::camera::StatusMonitor::m_monitorInterval

private

Interval at which the monitor thread executes runMonitor()

Definition at line 86 of file monitor.hpp.

m_monitorThread

std::thread irsol::camera::StatusMonitor::m_monitorThread

private

Thread running the periodic monitoring loop.

Definition at line 92 of file monitor.hpp.

---

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

• src/irsol/include/irsol/camera/monitor.hpp
• src/irsol/lib/irsol/camera/monitor.cpp