PowerMonitor Class

Collects Sentinel power samples over a measured interval. More...

Declaration

class simaai::neat::PowerMonitor { ... }

Included Headers

#include <PowerTelemetry.h>

Friends Index

struct	internal::PowerMonitorAccess

Public Constructors Index

	PowerMonitor (PowerMonitorOptions options={})
	PowerMonitor (const PowerMonitor &)=delete
	PowerMonitor (PowerMonitor &&) noexcept

Public Destructor Index

	~PowerMonitor ()

Public Operators Index

PowerMonitor &	operator= (const PowerMonitor &)=delete
PowerMonitor &	operator= (PowerMonitor &&) noexcept

Public Member Functions Index

void	start ()
	Start background sampling if enabled. More...
void	stop ()
	Stop background sampling and keep the final summary available. More...
void	sample_once ()
	Add Sentinel's latest sample now when it was not already added. More...
PowerSummary	summary () const
	Return the current aggregate summary. More...
bool	running () const
	True while the sampling thread is active. More...

Private Member Attributes Index

std::unique_ptr< Impl >	impl_

Description

Collects Sentinel power samples over a measured interval.

Start immediately before a measured interval and stop immediately after it. Only samples Sentinel takes in between are kept, so an interval shorter than about 2 s may have none. Never throws: when Sentinel cannot be read, the monitor warns once on stderr and collects no samples.

Deprecated

Use TelemetryMonitor, which also records temperatures, CPU usage, and memory.

Definition at line 235 of file PowerTelemetry.h.

Friends

internal::PowerMonitorAccess

friend struct internal::PowerMonitorAccess

Definition at line 258 of file PowerTelemetry.h.

Public Constructors

PowerMonitor()

simaai::neat::PowerMonitor::PowerMonitor (PowerMonitorOptions options={})

explicit

Definition at line 237 of file PowerTelemetry.h.

PowerMonitor()

simaai::neat::PowerMonitor::PowerMonitor (const PowerMonitor &)

delete

Definition at line 240 of file PowerTelemetry.h.

PowerMonitor()

simaai::neat::PowerMonitor::PowerMonitor (PowerMonitor &&)

noexcept

Definition at line 243 of file PowerTelemetry.h.

Public Destructor

~PowerMonitor()

simaai::neat::PowerMonitor::~PowerMonitor ()

Definition at line 238 of file PowerTelemetry.h.

Public Operators

operator=()

PowerMonitor & simaai::neat::PowerMonitor::operator= (const PowerMonitor &)

delete

Definition at line 241 of file PowerTelemetry.h.

operator=()

PowerMonitor & simaai::neat::PowerMonitor::operator= (PowerMonitor &&)

noexcept

Definition at line 244 of file PowerTelemetry.h.

Public Member Functions

running()

bool simaai::neat::PowerMonitor::running ()

True while the sampling thread is active.

Definition at line 255 of file PowerTelemetry.h.

sample_once()

void simaai::neat::PowerMonitor::sample_once ()

Add Sentinel's latest sample now when it was not already added.

Definition at line 251 of file PowerTelemetry.h.

start()

void simaai::neat::PowerMonitor::start ()

Start background sampling if enabled.

Definition at line 247 of file PowerTelemetry.h.

stop()

void simaai::neat::PowerMonitor::stop ()

Stop background sampling and keep the final summary available.

Definition at line 249 of file PowerTelemetry.h.

summary()

PowerSummary simaai::neat::PowerMonitor::summary ()

Return the current aggregate summary.

Definition at line 253 of file PowerTelemetry.h.

Private Member Attributes

impl_

std::unique_ptr<Impl> simaai::neat::PowerMonitor::impl_

Definition at line 260 of file PowerTelemetry.h.

---

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

• PowerTelemetry.h

---

Generated via doxygen2docusaurus 2.0.0 by Doxygen 1.15.0.