geopm::RatioSignal Class Reference

A composite signal used by an IOGroup to produce a signal as the Ratio of two signals. More...

#include <RatioSignal.hpp>

Inheritance diagram for geopm::RatioSignal:

Collaboration diagram for geopm::RatioSignal:

Public Member Functions
	RatioSignal (std::shared_ptr< Signal > numerator, std::shared_ptr< Signal > denominator)
	RatioSignal (const RatioSignal &other)=delete
RatioSignal &	operator= (const RatioSignal &other)=delete
virtual	~RatioSignal ()=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...

Detailed Description

A composite signal used by an IOGroup to produce a signal as the Ratio of two signals.

Constructor & Destructor Documentation

RatioSignal() [1/2]

geopm::RatioSignal::RatioSignal	(	std::shared_ptr< Signal >	numerator,
		std::shared_ptr< Signal >	denominator
	)

RatioSignal() [2/2]

geopm::RatioSignal::RatioSignal ( const RatioSignal &  other )

delete

~RatioSignal()

virtual geopm::RatioSignal::~RatioSignal ( )

virtualdefault

Member Function Documentation

operator=()

RatioSignal& geopm::RatioSignal::operator= ( const RatioSignal &  other )

delete

read()

double geopm::RatioSignal::read ( void  ) const

overridevirtual

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

Implements geopm::Signal.

sample()

double geopm::RatioSignal::sample ( void  )

overridevirtual

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

Implements geopm::Signal.

setup_batch()

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

• RatioSignal.hpp
• RatioSignal.cpp