class variable_value

Declaration

class variable_value { /* full declaration omitted */ };

Description

Class holding value of option. Contains details about how the value is set and allows to conveniently obtain the value.

Declared at: libs/pika/program_options/include/pika/program_options/variables_map.hpp:51

Method Overview

public template <class T>const T & as() const
public template <class T>T & as()
public bool defaulted() const
public bool empty() const
public const pika::any_nonser & value() const
public pika::any_nonser & value()
public variable_value()
public variable_value(const pika::any_nonser & xv, bool xdefaulted)

Methods

template <class T>
const T& as() const

Description

If stored value if of type T, returns that value. Otherwise, throws boost::bad_any_cast exception.

Declared at: libs/pika/program_options/include/pika/program_options/variables_map.hpp:67

template <class T>
T& as()

Declared at: libs/pika/program_options/include/pika/program_options/variables_map.hpp:73

bool defaulted() const

Description

Returns true if the value was not explicitly given, but has default value.

Declared at: libs/pika/program_options/include/pika/program_options/variables_map.hpp:82

bool empty() const

Description

Returns true if no value is stored.

Declared at: libs/pika/program_options/include/pika/program_options/variables_map.hpp:79

const pika::any_nonser& value() const

Description

Returns the contained value.

Declared at: libs/pika/program_options/include/pika/program_options/variables_map.hpp:84

pika::any_nonser& value()

Description

Returns the contained value.

Declared at: libs/pika/program_options/include/pika/program_options/variables_map.hpp:87

variable_value()

Declared at: libs/pika/program_options/include/pika/program_options/variables_map.hpp:54

variable_value(const pika::any_nonser& xv,
               bool xdefaulted)

Declared at: libs/pika/program_options/include/pika/program_options/variables_map.hpp:58

Parameters

const pika::any_nonser& xv
bool xdefaulted