SimGrid  3.21
Versatile Simulation of Distributed Systems
List of all members | Public Member Functions
simgrid::config::Flag< T > Class Template Reference

Detailed Description

template<class T>
class simgrid::config::Flag< T >

A variable bound to a CLI option. 


static simgrid::config::flag<int> answer("answer", "Expected answer", 42);
static simgrid::config::flag<std::string> name("name", "Ford Perfect", "John Doe");
static simgrid::config::flag<double> gamma("gamma", "Gamma factor", 1.987);

#include <config.hpp>

Public Member Functions

 Flag (const char *name, const char *desc, T value)
 Constructor. More...
 
 Flag (const char *name, std::initializer_list< const char *> aliases, const char *desc, T value)
 Constructor taking also an array of aliases for name. More...
 
template<class F >
 Flag (const char *name, const char *desc, T value, F callback)
 
template<class F >
 Flag (const char *name, std::initializer_list< const char *> aliases, const char *desc, T value, F callback)
 
template<class F >
 Flag (const char *name, const char *desc, T value, std::map< T, std::string > valid_values, F callback)
 
template<class F >
 Flag (const char *name, std::initializer_list< const char *> aliases, const char *desc, T value, std::map< T, std::string > valid_values, F callback)
 
 Flag (Flag const &)=delete
 
Flag & operator= (Flag const &)=delete
 
T & get ()
 
T const & get () const
 
std::string get_name () const
 
 operator T & ()
 
 operator T const & () const
 
template<class U >
Flag & operator= (U const &that)
 
template<class U >
Flag & operator= (U &&that)
 
template<class U >
bool operator== (U const &that) const
 
template<class U >
bool operator!= (U const &that) const
 
template<class U >
bool operator< (U const &that) const
 
template<class U >
bool operator> (U const &that) const
 
template<class U >
bool operator<= (U const &that) const
 
template<class U >
bool operator>= (U const &that) const
 

Constructor & Destructor Documentation

◆ Flag() [1/7]

template<class T >
simgrid::config::Flag< T >::Flag ( const char *  name,
const char *  desc,
T  value 
)
inline

Constructor.

Parameters
nameFlag name
descFlag description
valueFlag initial/default value

◆ Flag() [2/7]

template<class T >
simgrid::config::Flag< T >::Flag ( const char *  name,
std::initializer_list< const char *>  aliases,
const char *  desc,
T  value 
)
inline

Constructor taking also an array of aliases for name.

◆ Flag() [3/7]

template<class T >
template<class F >
simgrid::config::Flag< T >::Flag ( const char *  name,
const char *  desc,
T  value,
F  callback 
)
inline

◆ Flag() [4/7]

template<class T >
template<class F >
simgrid::config::Flag< T >::Flag ( const char *  name,
std::initializer_list< const char *>  aliases,
const char *  desc,
T  value,
F  callback 
)
inline

◆ Flag() [5/7]

template<class T >
template<class F >
simgrid::config::Flag< T >::Flag ( const char *  name,
const char *  desc,
T  value,
std::map< T, std::string >  valid_values,
F  callback 
)
inline

◆ Flag() [6/7]

template<class T >
template<class F >
simgrid::config::Flag< T >::Flag ( const char *  name,
std::initializer_list< const char *>  aliases,
const char *  desc,
T  value,
std::map< T, std::string >  valid_values,
F  callback 
)
inline

◆ Flag() [7/7]

template<class T >
simgrid::config::Flag< T >::Flag ( Flag< T > const &  )
delete

Member Function Documentation

◆ operator=() [1/3]

template<class T >
Flag& simgrid::config::Flag< T >::operator= ( Flag< T > const &  )
delete

◆ get() [1/2]

template<class T >
T& simgrid::config::Flag< T >::get ( )
inline

◆ get() [2/2]

template<class T >
T const& simgrid::config::Flag< T >::get ( ) const
inline

◆ get_name()

template<class T >
std::string simgrid::config::Flag< T >::get_name ( ) const
inline

◆ operator T &()

template<class T >
simgrid::config::Flag< T >::operator T& ( )
inline

◆ operator T const &()

template<class T >
simgrid::config::Flag< T >::operator T const & ( ) const
inline

◆ operator=() [2/3]

template<class T >
template<class U >
Flag& simgrid::config::Flag< T >::operator= ( U const &  that)
inline

◆ operator=() [3/3]

template<class T >
template<class U >
Flag& simgrid::config::Flag< T >::operator= ( U &&  that)
inline

◆ operator==()

template<class T >
template<class U >
bool simgrid::config::Flag< T >::operator== ( U const &  that) const
inline

◆ operator!=()

template<class T >
template<class U >
bool simgrid::config::Flag< T >::operator!= ( U const &  that) const
inline

◆ operator<()

template<class T >
template<class U >
bool simgrid::config::Flag< T >::operator< ( U const &  that) const
inline

◆ operator>()

template<class T >
template<class U >
bool simgrid::config::Flag< T >::operator> ( U const &  that) const
inline

◆ operator<=()

template<class T >
template<class U >
bool simgrid::config::Flag< T >::operator<= ( U const &  that) const
inline

◆ operator>=()

template<class T >
template<class U >
bool simgrid::config::Flag< T >::operator>= ( U const &  that) const
inline
The documentation for this class was generated from the following file: