PowerMonitor Class

Background SOM power sampler. More...

Declaration

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

Included Headers

#include <PowerTelemetry.h>

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 ()
	Collect one sample synchronously. 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

Background SOM power sampler.

Start immediately before a measured interval and stop immediately after it. Read failures are counted per field and never throw; unavailable fields are omitted from averages.

Definition at line 212 of file PowerTelemetry.h.

Public Constructors

PowerMonitor()

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

explicit

Definition at line 214 of file PowerTelemetry.h.

PowerMonitor()

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

delete

Definition at line 217 of file PowerTelemetry.h.

PowerMonitor()

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

noexcept

Definition at line 220 of file PowerTelemetry.h.

Public Destructor

~PowerMonitor()

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

Definition at line 215 of file PowerTelemetry.h.

Public Operators

operator=()

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

delete

Definition at line 218 of file PowerTelemetry.h.

operator=()

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

noexcept

Definition at line 221 of file PowerTelemetry.h.

Public Member Functions

running()

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

True while the sampling thread is active.

Definition at line 232 of file PowerTelemetry.h.

sample_once()

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

Collect one sample synchronously.

Useful for tests and one-shot diagnostics.

Definition at line 228 of file PowerTelemetry.h.

start()

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

Start background sampling if enabled.

Definition at line 224 of file PowerTelemetry.h.

stop()

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

Stop background sampling and keep the final summary available.

Definition at line 226 of file PowerTelemetry.h.

summary()

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

Return the current aggregate summary.

Definition at line 230 of file PowerTelemetry.h.

Private Member Attributes

impl_

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

Definition at line 236 of file PowerTelemetry.h.

236 std::unique_ptr<Impl> impl_;

---

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

• PowerTelemetry.h

---

Generated via doxygen2docusaurus 2.0.0 by Doxygen 1.9.8.