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

#include <LevelZeroSignal.hpp>

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

Public Member Functions

virtual ~LevelZeroSignal ()=default
 
 LevelZeroSignal (std::function< double(unsigned int)> devpool_func, unsigned int gpu, double scalar)
 
 LevelZeroSignal (const LevelZeroSignal &other)=delete
 
LevelZeroSignaloperator= (const LevelZeroSignal &other)=delete
 
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...
 
void set_sample (double value) override
 Set the value to be returned by sample() More...
 
bool is_sampled (void) const override
 True if the signal has been sampled during this batch. More...
 
- Public Member Functions inherited from geopm::Signal
virtual ~Signal ()=default
 

Constructor & Destructor Documentation

◆ ~LevelZeroSignal()

virtual geopm::LevelZeroSignal::~LevelZeroSignal ( )
virtualdefault

◆ LevelZeroSignal() [1/2]

geopm::LevelZeroSignal::LevelZeroSignal ( std::function< double(unsigned int)>  devpool_func,
unsigned int  gpu,
double  scalar 
)

◆ LevelZeroSignal() [2/2]

geopm::LevelZeroSignal::LevelZeroSignal ( const LevelZeroSignal other)
delete

Member Function Documentation

◆ is_sampled()

bool geopm::LevelZeroSignal::is_sampled ( void  ) const
overridevirtual

True if the signal has been sampled during this batch.

Reimplemented from geopm::Signal.

◆ operator=()

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

◆ read()

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

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

Implements geopm::Signal.

◆ sample()

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

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

Implements geopm::Signal.

◆ set_sample()

void geopm::LevelZeroSignal::set_sample ( double  )
overridevirtual

Set the value to be returned by sample()

Reimplemented from geopm::Signal.

◆ setup_batch()

void geopm::LevelZeroSignal::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: