geopm::Environment Class Reference

Environment class encapsulates all functionality related to dealing with runtime environment variables. More...

#include <Environment.hpp>

Inheritance diagram for geopm::Environment:

Public Types
enum	m_ctl_e { M_CTL_NONE , M_CTL_PROCESS , M_CTL_PTHREAD }
	Enum for controller launch methods. More...

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

Static Public Member Functions
static std::map< std::string, std::string >	parse_environment_file (const std::string &env_file_path)

Detailed Description

Environment class encapsulates all functionality related to dealing with runtime environment variables.

Member Enumeration Documentation

m_ctl_e

enum geopm::Environment::m_ctl_e

Enum for controller launch methods.

The return value from pmpi_ctl() is one of these.

Enumerator
M_CTL_NONE
M_CTL_PROCESS
M_CTL_PTHREAD

Constructor & Destructor Documentation

Environment()

geopm::Environment::Environment ( )

default

~Environment()

virtual geopm::Environment::~Environment ( )

virtualdefault

Member Function Documentation

agent()

virtual std::string geopm::Environment::agent ( void  ) const

pure virtual

Implemented in geopm::EnvironmentImp.

comm()

virtual std::string geopm::Environment::comm ( void  ) const

pure virtual

Implemented in geopm::EnvironmentImp.

debug_attach_process()

virtual int geopm::Environment::debug_attach_process ( void  ) const

pure virtual

Implemented in geopm::EnvironmentImp.

default_config_path()

virtual std::string geopm::Environment::default_config_path ( void  ) const

pure virtual

Implemented in geopm::EnvironmentImp.

do_ctl_local()

virtual bool geopm::Environment::do_ctl_local ( void  ) const

pure virtual

Implemented in geopm::EnvironmentImp.

do_debug_attach_all()

virtual bool geopm::Environment::do_debug_attach_all ( void  ) const

pure virtual

Implemented in geopm::EnvironmentImp.

do_debug_attach_one()

virtual bool geopm::Environment::do_debug_attach_one ( void  ) const

pure virtual

Implemented in geopm::EnvironmentImp.

do_endpoint()

virtual bool geopm::Environment::do_endpoint ( void  ) const

pure virtual

Implemented in geopm::EnvironmentImp.

do_init_control()

virtual bool geopm::Environment::do_init_control ( void  ) const

pure virtual

Implemented in geopm::EnvironmentImp.

do_ompt()

virtual bool geopm::Environment::do_ompt ( void  ) const

pure virtual

Implemented in geopm::EnvironmentImp.

do_policy()

virtual bool geopm::Environment::do_policy ( void  ) const

pure virtual

Implemented in geopm::EnvironmentImp.

do_profile()

virtual bool geopm::Environment::do_profile ( void  ) const

pure virtual

Implemented in geopm::EnvironmentImp.

do_record_filter()

virtual bool geopm::Environment::do_record_filter ( void  ) const

pure virtual

Implemented in geopm::EnvironmentImp.

do_trace()

virtual bool geopm::Environment::do_trace ( void  ) const

pure virtual

Implemented in geopm::EnvironmentImp.

do_trace_endpoint_policy()

virtual bool geopm::Environment::do_trace_endpoint_policy ( void  ) const

pure virtual

Implemented in geopm::EnvironmentImp.

do_trace_profile()

virtual bool geopm::Environment::do_trace_profile ( void  ) const

pure virtual

Implemented in geopm::EnvironmentImp.

endpoint()

virtual std::string geopm::Environment::endpoint ( void  ) const

pure virtual

Implemented in geopm::EnvironmentImp.

frequency_map()

virtual std::string geopm::Environment::frequency_map ( void  ) const

pure virtual

Implemented in geopm::EnvironmentImp.

init_control()

virtual std::string geopm::Environment::init_control ( void  ) const

pure virtual

Implemented in geopm::EnvironmentImp.

max_fan_out()

virtual int geopm::Environment::max_fan_out ( void  ) const

pure virtual

Implemented in geopm::EnvironmentImp.

num_proc()

virtual int geopm::Environment::num_proc ( void  ) const

pure virtual

Implemented in geopm::EnvironmentImp.

override_config_path()

virtual std::string geopm::Environment::override_config_path ( void  ) const

pure virtual

Implemented in geopm::EnvironmentImp.

parse_environment_file()

std::map< std::string, std::string > geopm::Environment::parse_environment_file ( const std::string &  env_file_path )

static

period()

virtual double geopm::Environment::period ( double  default_period ) const

pure virtual

Implemented in geopm::EnvironmentImp.

pmpi_ctl()

virtual int geopm::Environment::pmpi_ctl ( void  ) const

pure virtual

Implemented in geopm::EnvironmentImp.

policy()

virtual std::string geopm::Environment::policy ( void  ) const

pure virtual

Implemented in geopm::EnvironmentImp.

profile()

virtual std::string geopm::Environment::profile ( void  ) const

pure virtual

Implemented in geopm::EnvironmentImp.

record_filter()

virtual std::string geopm::Environment::record_filter ( void  ) const

pure virtual

Implemented in geopm::EnvironmentImp.

report()

virtual std::string geopm::Environment::report ( void  ) const

pure virtual

Implemented in geopm::EnvironmentImp.

report_signals()

virtual std::string geopm::Environment::report_signals ( void  ) const

pure virtual

Implemented in geopm::EnvironmentImp.

timeout()

virtual int geopm::Environment::timeout ( void  ) const

pure virtual

Implemented in geopm::EnvironmentImp.

trace()

virtual std::string geopm::Environment::trace ( void  ) const

pure virtual

Implemented in geopm::EnvironmentImp.

trace_endpoint_policy()

virtual std::string geopm::Environment::trace_endpoint_policy ( void  ) const

pure virtual

Implemented in geopm::EnvironmentImp.

trace_profile()

virtual std::string geopm::Environment::trace_profile ( void  ) const

pure virtual

Implemented in geopm::EnvironmentImp.

trace_signals()

virtual std::string geopm::Environment::trace_signals ( void  ) const

pure virtual

Implemented in geopm::EnvironmentImp.

---

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

• Environment.hpp
• Environment.cpp