geopm  3.1.1.dev296+g5916b956
GEOPM - Global Extensible Open Power Manager
Public Member Functions | Static Public Member Functions | List of all members
geopm::EndpointUser Class Referenceabstract

#include <EndpointUser.hpp>

Inheritance diagram for geopm::EndpointUser:
Inheritance graph
[legend]

Public Member Functions

 EndpointUser ()=default
 
virtual ~EndpointUser ()=default
 
virtual double read_policy (std::vector< double > &policy)=0
 Read the latest policy values. All NAN indicates that a policy has not been written yet. More...
 
virtual void write_sample (const std::vector< double > &sample)=0
 Write sample values and update the sample age. More...
 

Static Public Member Functions

static std::unique_ptr< EndpointUsermake_unique (const std::string &policy_path, const std::set< std::string > &hosts)
 Factory method for the EndpointUser receiving the policy. More...
 

Constructor & Destructor Documentation

◆ EndpointUser()

geopm::EndpointUser::EndpointUser ( )
default

◆ ~EndpointUser()

virtual geopm::EndpointUser::~EndpointUser ( )
virtualdefault

Member Function Documentation

◆ make_unique()

std::unique_ptr< EndpointUser > geopm::EndpointUser::make_unique ( const std::string &  policy_path,
const std::set< std::string > &  hosts 
)
static

Factory method for the EndpointUser receiving the policy.

◆ read_policy()

virtual double geopm::EndpointUser::read_policy ( std::vector< double > &  policy)
pure virtual

Read the latest policy values. All NAN indicates that a policy has not been written yet.

Parameters
[out]policyThe policy values read. The order is specified by the Agent.
Returns
The age of the policy in seconds.

Implemented in geopm::EndpointUserImp.

◆ write_sample()

virtual void geopm::EndpointUser::write_sample ( const std::vector< double > &  sample)
pure virtual

Write sample values and update the sample age.

Parameters
[in]sampleThe values to write. The order is specified by the Agent.

Implemented in geopm::EndpointUserImp.


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