WRENCH  1.11
Cyberinfrastructure Simulation Workbench
Overview Installation Getting Started WRENCH 101 WRENCH 102
Public Member Functions | List of all members
wrench::EnergyMeterService Class Reference

A service that measures and records energy consumption on a set of hosts at regular time intervals. More...

#include <EnergyMeterService.h>

Inheritance diagram for wrench::EnergyMeterService:
wrench::Service

Public Member Functions

 EnergyMeterService (std::string hostname, const std::map< std::string, double > &measurement_periods)
 Constructor. More...
 
 EnergyMeterService (std::string hostname, const std::vector< std::string > &hostnames, double period)
 Constructor. More...
 
void kill ()
 Kill the energy meter (brutally terminate the daemon)
 
void stop () override
 Stop the energy meter. More...
 
- Public Member Functions inherited from wrench::Service
void assertServiceIsUp ()
 Throws an exception if the service is not up. More...
 
std::string getHostname ()
 Get the name of the host on which the service is / will be running. More...
 
double getNetworkTimeoutValue ()
 Returns the service's network timeout value. More...
 
std::string getPhysicalHostname ()
 Get the physical name of the host on which the service is / will be running. More...
 
bool getPropertyValueAsBoolean (WRENCH_PROPERTY_TYPE)
 Get a property of the Service as a boolean. More...
 
double getPropertyValueAsDouble (WRENCH_PROPERTY_TYPE)
 Get a property of the Service as a double. More...
 
std::string getPropertyValueAsString (WRENCH_PROPERTY_TYPE)
 Get a property of the Service as a string. More...
 
unsigned long getPropertyValueAsUnsignedLong (WRENCH_PROPERTY_TYPE)
 Get a property of the Service as an unsigned long. More...
 
bool isUp ()
 Returns true if the service is UP, false otherwise. More...
 
void resume ()
 Resume the service. More...
 
void setNetworkTimeoutValue (double value)
 Sets the service's network timeout value. More...
 
void start (std::shared_ptr< Service > this_service, bool daemonize, bool auto_restart)
 Start the service. More...
 
void suspend ()
 Suspend the service.
 

Detailed Description

A service that measures and records energy consumption on a set of hosts at regular time intervals.

Constructor & Destructor Documentation

◆ EnergyMeterService() [1/2]

wrench::EnergyMeterService::EnergyMeterService ( std::string  hostname,
const std::vector< std::string > &  hostnames,
double  measurement_period 
)

Constructor.

Parameters
hostnamethe name of the host on which this service is running
hostnamesthe list of metered hosts, as hostnames
measurement_periodthe measurement period

◆ EnergyMeterService() [2/2]

wrench::EnergyMeterService::EnergyMeterService ( std::string  hostname,
const std::map< std::string, double > &  measurement_periods 
)

Constructor.

Parameters
hostnamethe hostname on which the service should start
measurement_periodsthe measurement period for each metered host

Member Function Documentation

◆ stop()

void wrench::EnergyMeterService::stop ( )
overridevirtual

Stop the energy meter.

Exceptions
ExecutionException
std::runtime_error

Reimplemented from wrench::Service.


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