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

#include <Environment.hpp>

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

Public Member Functions

 EnvironmentImp ()
 
 EnvironmentImp (const std::string &default_settings_path, const std::string &override_settings_path)
 
virtual ~EnvironmentImp ()=default
 
std::string report (void) const override
 
std::string comm (void) const override
 
std::string policy (void) const override
 
std::string endpoint (void) const override
 
std::string trace (void) const override
 
std::string trace_profile (void) const override
 
std::string trace_endpoint_policy (void) const override
 
std::string profile (void) const override
 
std::string frequency_map (void) const override
 
std::string agent (void) const override
 
std::string trace_signals (void) const override
 
std::string report_signals (void) const override
 
int max_fan_out (void) const override
 
int pmpi_ctl (void) const override
 
bool do_policy (void) const override
 
bool do_endpoint (void) const override
 
bool do_trace (void) const override
 
bool do_trace_profile (void) const override
 
bool do_trace_endpoint_policy (void) const override
 
bool do_profile () const override
 
int timeout (void) const override
 
bool do_ompt (void) const override
 
std::string default_config_path (void) const override
 
std::string override_config_path (void) const override
 
std::string record_filter (void) const override
 
bool do_record_filter (void) const override
 
bool do_debug_attach_all (void) const override
 
bool do_debug_attach_one (void) const override
 
bool do_init_control (void) const override
 
int debug_attach_process (void) const override
 
std::string init_control (void) const override
 
double period (double default_period) const override
 
int num_proc (void) const override
 
bool do_ctl_local (void) const override
 
- Public Member Functions inherited from geopm::Environment
 Environment ()=default
 
virtual ~Environment ()=default
 

Static Public Member Functions

static std::set< std::string > get_all_vars (void)
 
static void parse_environment_file (const std::string &settings_path, const std::set< std::string > &all_names, const std::set< std::string > &user_defined_names, std::map< std::string, std::string > &name_value_map)
 
- Static Public Member Functions inherited from geopm::Environment
static std::map< std::string, std::string > parse_environment_file (const std::string &env_file_path)
 

Protected Member Functions

void parse_environment (void)
 
bool is_set (const std::string &env_var) const
 
std::string lookup (const std::string &env_var) const
 

Protected Attributes

const std::set< std::string > m_all_names
 
std::set< std::string > m_user_defined_names
 
std::map< std::string, std::string > m_name_value_map
 
const std::string m_default_config_path
 
const std::string m_override_config_path
 

Additional Inherited Members

- Public Types inherited from geopm::Environment
enum  m_ctl_e { M_CTL_NONE , M_CTL_PROCESS , M_CTL_PTHREAD }
 Enum for controller launch methods. More...
 

Constructor & Destructor Documentation

◆ EnvironmentImp() [1/2]

geopm::EnvironmentImp::EnvironmentImp ( )

◆ EnvironmentImp() [2/2]

geopm::EnvironmentImp::EnvironmentImp ( const std::string &  default_settings_path,
const std::string &  override_settings_path 
)

◆ ~EnvironmentImp()

virtual geopm::EnvironmentImp::~EnvironmentImp ( )
virtualdefault

Member Function Documentation

◆ agent()

std::string geopm::EnvironmentImp::agent ( void  ) const
overridevirtual

Implements geopm::Environment.

◆ comm()

std::string geopm::EnvironmentImp::comm ( void  ) const
overridevirtual

Implements geopm::Environment.

◆ debug_attach_process()

int geopm::EnvironmentImp::debug_attach_process ( void  ) const
overridevirtual

Implements geopm::Environment.

◆ default_config_path()

std::string geopm::EnvironmentImp::default_config_path ( void  ) const
overridevirtual

Implements geopm::Environment.

◆ do_ctl_local()

bool geopm::EnvironmentImp::do_ctl_local ( void  ) const
overridevirtual

Implements geopm::Environment.

◆ do_debug_attach_all()

bool geopm::EnvironmentImp::do_debug_attach_all ( void  ) const
overridevirtual

Implements geopm::Environment.

◆ do_debug_attach_one()

bool geopm::EnvironmentImp::do_debug_attach_one ( void  ) const
overridevirtual

Implements geopm::Environment.

◆ do_endpoint()

bool geopm::EnvironmentImp::do_endpoint ( void  ) const
overridevirtual

Implements geopm::Environment.

◆ do_init_control()

bool geopm::EnvironmentImp::do_init_control ( void  ) const
overridevirtual

Implements geopm::Environment.

◆ do_ompt()

bool geopm::EnvironmentImp::do_ompt ( void  ) const
overridevirtual

Implements geopm::Environment.

◆ do_policy()

bool geopm::EnvironmentImp::do_policy ( void  ) const
overridevirtual

Implements geopm::Environment.

◆ do_profile()

bool geopm::EnvironmentImp::do_profile ( void  ) const
overridevirtual

Implements geopm::Environment.

◆ do_record_filter()

bool geopm::EnvironmentImp::do_record_filter ( void  ) const
overridevirtual

Implements geopm::Environment.

◆ do_trace()

bool geopm::EnvironmentImp::do_trace ( void  ) const
overridevirtual

Implements geopm::Environment.

◆ do_trace_endpoint_policy()

bool geopm::EnvironmentImp::do_trace_endpoint_policy ( void  ) const
overridevirtual

Implements geopm::Environment.

◆ do_trace_profile()

bool geopm::EnvironmentImp::do_trace_profile ( void  ) const
overridevirtual

Implements geopm::Environment.

◆ endpoint()

std::string geopm::EnvironmentImp::endpoint ( void  ) const
overridevirtual

Implements geopm::Environment.

◆ frequency_map()

std::string geopm::EnvironmentImp::frequency_map ( void  ) const
overridevirtual

Implements geopm::Environment.

◆ get_all_vars()

std::set< std::string > geopm::EnvironmentImp::get_all_vars ( void  )
static

◆ init_control()

std::string geopm::EnvironmentImp::init_control ( void  ) const
overridevirtual

Implements geopm::Environment.

◆ is_set()

bool geopm::EnvironmentImp::is_set ( const std::string &  env_var) const
protected

◆ lookup()

std::string geopm::EnvironmentImp::lookup ( const std::string &  env_var) const
protected

◆ max_fan_out()

int geopm::EnvironmentImp::max_fan_out ( void  ) const
overridevirtual

Implements geopm::Environment.

◆ num_proc()

int geopm::EnvironmentImp::num_proc ( void  ) const
overridevirtual

Implements geopm::Environment.

◆ override_config_path()

std::string geopm::EnvironmentImp::override_config_path ( void  ) const
overridevirtual

Implements geopm::Environment.

◆ parse_environment()

void geopm::EnvironmentImp::parse_environment ( void  )
protected

◆ parse_environment_file()

void geopm::EnvironmentImp::parse_environment_file ( const std::string &  settings_path,
const std::set< std::string > &  all_names,
const std::set< std::string > &  user_defined_names,
std::map< std::string, std::string > &  name_value_map 
)
static

◆ period()

double geopm::EnvironmentImp::period ( double  default_period) const
overridevirtual

Implements geopm::Environment.

◆ pmpi_ctl()

int geopm::EnvironmentImp::pmpi_ctl ( void  ) const
overridevirtual

Implements geopm::Environment.

◆ policy()

std::string geopm::EnvironmentImp::policy ( void  ) const
overridevirtual

Implements geopm::Environment.

◆ profile()

std::string geopm::EnvironmentImp::profile ( void  ) const
overridevirtual

Implements geopm::Environment.

◆ record_filter()

std::string geopm::EnvironmentImp::record_filter ( void  ) const
overridevirtual

Implements geopm::Environment.

◆ report()

std::string geopm::EnvironmentImp::report ( void  ) const
overridevirtual

Implements geopm::Environment.

◆ report_signals()

std::string geopm::EnvironmentImp::report_signals ( void  ) const
overridevirtual

Implements geopm::Environment.

◆ timeout()

int geopm::EnvironmentImp::timeout ( void  ) const
overridevirtual

Implements geopm::Environment.

◆ trace()

std::string geopm::EnvironmentImp::trace ( void  ) const
overridevirtual

Implements geopm::Environment.

◆ trace_endpoint_policy()

std::string geopm::EnvironmentImp::trace_endpoint_policy ( void  ) const
overridevirtual

Implements geopm::Environment.

◆ trace_profile()

std::string geopm::EnvironmentImp::trace_profile ( void  ) const
overridevirtual

Implements geopm::Environment.

◆ trace_signals()

std::string geopm::EnvironmentImp::trace_signals ( void  ) const
overridevirtual

Implements geopm::Environment.

Member Data Documentation

◆ m_all_names

const std::set<std::string> geopm::EnvironmentImp::m_all_names
protected

◆ m_default_config_path

const std::string geopm::EnvironmentImp::m_default_config_path
protected

◆ m_name_value_map

std::map<std::string, std::string> geopm::EnvironmentImp::m_name_value_map
protected

◆ m_override_config_path

const std::string geopm::EnvironmentImp::m_override_config_path
protected

◆ m_user_defined_names

std::set<std::string> geopm::EnvironmentImp::m_user_defined_names
protected

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