class value_semantic

Declaration

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

Description

Class which specifies how the option's value is to be parsed and converted into C++ types.

Declared at: libs/pika/program_options/include/pika/program_options/value_semantic.hpp:25

Method Overview

• public virtual bool apply_default(pika::any_nonser & value_store) const
• public virtual bool is_composing() const
• public virtual bool is_required() const
• public virtual unsigned int max_tokens() const
• public virtual unsigned int min_tokens() const
• public virtual std::string name() const
• public virtual void notify(const pika::any_nonser & value_store) const
• public virtual void parse(pika::any_nonser & value_store, const std::vector<std::string> & new_tokens, bool utf8) const
• public virtual ~value_semantic()

Methods

virtual bool apply_default(
    pika::any_nonser& value_store) const

Description

Called to assign default value to 'value_store'. Returns true if default value is assigned, and false if no default value exists.

Declared at: libs/pika/program_options/include/pika/program_options/value_semantic.hpp:63

Parameters

pika::any_nonser& value_store

virtual bool is_composing() const

Description

Returns true if values from different sources should be composed. Otherwise, value from the first source is used and values from other sources are discarded.

Declared at: libs/pika/program_options/include/pika/program_options/value_semantic.hpp:45

virtual bool is_required() const

Description

Returns true if value must be given. Non-optional value

Declared at: libs/pika/program_options/include/pika/program_options/value_semantic.hpp:50

virtual unsigned int max_tokens() const

Description

The maximum number of tokens for this option that should be present on the command line.

Declared at: libs/pika/program_options/include/pika/program_options/value_semantic.hpp:39

virtual unsigned int min_tokens() const

Description

The minimum number of tokens for this option that should be present on the command line.

Declared at: libs/pika/program_options/include/pika/program_options/value_semantic.hpp:35

virtual std::string name() const

Description

Returns the name of the option. The name is only meaningful for automatic help message.

Declared at: libs/pika/program_options/include/pika/program_options/value_semantic.hpp:31

virtual void notify(
    const pika::any_nonser& value_store) const

Description

Called when final value of an option is determined.

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

Parameters

const pika::any_nonser& value_store

virtual void parse(
    pika::any_nonser& value_store,
    const std::vector<std::string>& new_tokens,
    bool utf8) const

Description

Parses a group of tokens that specify a value of option. Stores the result in 'value_store', using whatever representation is desired. May be be called several times if value of the same option is specified more than once.

Declared at: libs/pika/program_options/include/pika/program_options/value_semantic.hpp:57

Parameters

pika::any_nonser& value_store

const std::vector<std::string>& new_tokens

bool utf8

virtual ~value_semantic()

Declared at: libs/pika/program_options/include/pika/program_options/value_semantic.hpp:69