geopm  3.1.1.dev214+gba4f9f6d
GEOPM - Global Extensible Open Power Manager
Public Member Functions | List of all members
geopm::EndpointUserImp Class Reference

#include <EndpointUser.hpp>

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

Public Member Functions

 EndpointUserImp ()=delete
 
EndpointUserImpoperator= (const EndpointUserImp &other)=delete
 
 EndpointUserImp (const EndpointUserImp &other)=delete
 
 EndpointUserImp (const std::string &data_path, const std::set< std::string > &hosts)
 
 EndpointUserImp (const std::string &data_path, std::unique_ptr< SharedMemory > policy_shmem, std::unique_ptr< SharedMemory > sample_shmem, const std::string &agent_name, int num_sample, const std::string &profile_name, const std::string &hostlist_path, const std::set< std::string > &hosts)
 
virtual ~EndpointUserImp ()
 
double read_policy (std::vector< double > &policy) override
 Read the latest policy values. All NAN indicates that a policy has not been written yet. More...
 
void write_sample (const std::vector< double > &sample) override
 Write sample values and update the sample age. More...
 
- Public Member Functions inherited from geopm::EndpointUser
 EndpointUser ()=default
 
virtual ~EndpointUser ()=default
 

Additional Inherited Members

- Static Public Member Functions inherited from geopm::EndpointUser
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

◆ EndpointUserImp() [1/4]

geopm::EndpointUserImp::EndpointUserImp ( )
delete

◆ EndpointUserImp() [2/4]

geopm::EndpointUserImp::EndpointUserImp ( const EndpointUserImp other)
delete

◆ EndpointUserImp() [3/4]

geopm::EndpointUserImp::EndpointUserImp ( const std::string &  data_path,
const std::set< std::string > &  hosts 
)

◆ EndpointUserImp() [4/4]

geopm::EndpointUserImp::EndpointUserImp ( const std::string &  data_path,
std::unique_ptr< SharedMemory >  policy_shmem,
std::unique_ptr< SharedMemory >  sample_shmem,
const std::string &  agent_name,
int  num_sample,
const std::string &  profile_name,
const std::string &  hostlist_path,
const std::set< std::string > &  hosts 
)

write hostnames to file

◆ ~EndpointUserImp()

geopm::EndpointUserImp::~EndpointUserImp ( )
virtual

Member Function Documentation

◆ operator=()

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

◆ read_policy()

double geopm::EndpointUserImp::read_policy ( std::vector< double > &  policy)
overridevirtual

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.

Implements geopm::EndpointUser.

◆ write_sample()

void geopm::EndpointUserImp::write_sample ( const std::vector< double > &  sample)
overridevirtual

Write sample values and update the sample age.

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

Implements geopm::EndpointUser.


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