AutoPas  3.0.0
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Static Public Member Functions | List of all members
autopas::EnergySensorOption Class Reference

Class representing the different energy sensor options. More...

#include <EnergySensorOption.h>

Inheritance diagram for autopas::EnergySensorOption:
Inheritance graph
[legend]
Collaboration diagram for autopas::EnergySensorOption:
Collaboration graph
[legend]

Public Types

enum  Value { likwid , rapl }
 Possible choices for energy sensor. More...
 

Public Member Functions

 EnergySensorOption ()=default
 Cosntructor.
 
constexpr EnergySensorOption (Value option)
 Cosntructor with selected option.
 
constexpr operator Value () const
 Cast to value.
 

Static Public Member Functions

static std::map< EnergySensorOption, std::string > getOptionNames ()
 Provide a way to iterate over the options of EnergySensorOption.
 

Detailed Description

Class representing the different energy sensor options.

Member Enumeration Documentation

◆ Value

Possible choices for energy sensor.

Enumerator
likwid 

Use LIKWID.

rapl 

Use RAPL.

Constructor & Destructor Documentation

◆ EnergySensorOption()

constexpr autopas::EnergySensorOption::EnergySensorOption ( Value  option)
inlineconstexpr

Cosntructor with selected option.

Parameters
option

Member Function Documentation

◆ getOptionNames()

static std::map< EnergySensorOption, std::string > autopas::EnergySensorOption::getOptionNames ( )
inlinestatic

Provide a way to iterate over the options of EnergySensorOption.

Returns
map option -> string representation

◆ operator Value()

constexpr autopas::EnergySensorOption::operator Value ( ) const
inlineconstexpr

Cast to value.

Returns

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