geopm  3.1.1.dev272+gdfb40a8d
GEOPM - Global Extensible Open Power Manager
Public Member Functions | List of all members
geopm::RawMSRSignal Class Reference

#include <RawMSRSignal.hpp>

Inheritance diagram for geopm::RawMSRSignal:
Inheritance graph
[legend]
Collaboration diagram for geopm::RawMSRSignal:
Collaboration graph
[legend]

Public Member Functions

 RawMSRSignal (std::shared_ptr< MSRIO > msrio, int cpu, uint64_t offset)
 
 RawMSRSignal (const RawMSRSignal &other)=delete
 
RawMSRSignaloperator= (const RawMSRSignal &other)=delete
 
virtual ~RawMSRSignal ()=default
 
void setup_batch (void) override
 Prepare the signal for being updated through side effects by the owner's read_batch step. This method should not fail if called multiple times, and ideally only apply the side effects on the first call. More...
 
double sample (void) override
 Apply any conversions necessary to interpret the latest stored value as a double. More...
 
double read (void) const override
 Read directly the value of the signal without affecting any pushed batch signals. More...
 
- Public Member Functions inherited from geopm::Signal
virtual ~Signal ()=default
 
virtual void set_sample (double)
 Set the value to be returned by sample() More...
 
virtual bool is_sampled (void) const
 True if the signal has been sampled during this batch. More...
 

Constructor & Destructor Documentation

◆ RawMSRSignal() [1/2]

geopm::RawMSRSignal::RawMSRSignal ( std::shared_ptr< MSRIO msrio,
int  cpu,
uint64_t  offset 
)

◆ RawMSRSignal() [2/2]

geopm::RawMSRSignal::RawMSRSignal ( const RawMSRSignal other)
delete

◆ ~RawMSRSignal()

virtual geopm::RawMSRSignal::~RawMSRSignal ( )
virtualdefault

Member Function Documentation

◆ operator=()

RawMSRSignal& geopm::RawMSRSignal::operator= ( const RawMSRSignal other)
delete

◆ read()

double geopm::RawMSRSignal::read ( void  ) const
overridevirtual

Read directly the value of the signal without affecting any pushed batch signals.

Implements geopm::Signal.

◆ sample()

double geopm::RawMSRSignal::sample ( void  )
overridevirtual

Apply any conversions necessary to interpret the latest stored value as a double.

Implements geopm::Signal.

◆ setup_batch()

void geopm::RawMSRSignal::setup_batch ( void  )
overridevirtual

Prepare the signal for being updated through side effects by the owner's read_batch step. This method should not fail if called multiple times, and ideally only apply the side effects on the first call.

Implements geopm::Signal.


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