struct command_line_handling

Declaration

struct command_line_handling { /* full declaration omitted */ };

Declared at: libs/pika/command_line_handling/include/pika/command_line_handling/command_line_handling.hpp:23

Member Variables

public pika::program_options::variables_map vm_

public pika::util::runtime_configuration rtcfg_

public std::vector<std::string> ini_config_

public util::function<int( pika::program_options::variables_map&)> pika_main_f_

public std::size_t num_threads_

public std::size_t num_cores_

public std::size_t pu_step_

public std::size_t pu_offset_

public std::string queuing_

public std::string affinity_domain_

public std::string affinity_bind_

public std::size_t numa_sensitive_

public bool use_process_mask_

public bool cmd_line_parsed_

public bool info_printed_

public bool version_printed_

Method Overview

• public int call(const pika::program_options::options_description & desc_cmdline, int argc, char ** argv)
• protected void check_affinity_description() const
• protected void check_affinity_domain() const
• protected void check_pu_offset() const
• protected void check_pu_step() const
• public command_line_handling(pika::util::runtime_configuration rtcfg, std::vector<std::string> ini_config, util::function<int (pika::program_options::variables_map &)> pika_main_f)
• protected void enable_logging_settings(pika::program_options::variables_map & vm, std::vector<std::string> & ini_config)
• protected bool handle_arguments(util::manage_config & cfgmap, pika::program_options::variables_map & vm, std::vector<std::string> & ini_config)
• protected void handle_attach_debugger()
• protected bool handle_help_options(const pika::program_options::options_description & help)
• protected std::vector<std::string> preprocess_config_settings(int argc, char ** argv)
• protected void store_command_line(int argc, char ** argv)
• protected void store_unregistered_options(const std::string & cmd_name, const std::vector<std::string> & unregistered_options)

Methods

int call(const pika::program_options::
             options_description& desc_cmdline,
         int argc,
         char** argv)

Description

////////////////////////////////////////////////////////////////////////

Declared at: libs/pika/command_line_handling/include/pika/command_line_handling/command_line_handling.hpp:45

Parameters

const pika::program_options::options_description& desc_cmdline

int argc

char** argv

void check_affinity_description() const

Declared at: libs/pika/command_line_handling/include/pika/command_line_handling/command_line_handling.hpp:71

void check_affinity_domain() const

Description

////////////////////////////////////////////////////////////////////

Declared at: libs/pika/command_line_handling/include/pika/command_line_handling/command_line_handling.hpp:70

void check_pu_offset() const

Declared at: libs/pika/command_line_handling/include/pika/command_line_handling/command_line_handling.hpp:72

void check_pu_step() const

Declared at: libs/pika/command_line_handling/include/pika/command_line_handling/command_line_handling.hpp:73

command_line_handling(
    pika::util::runtime_configuration rtcfg,
    std::vector<std::string> ini_config,
    util::function<int(
        pika::program_options::variables_map&)>
        pika_main_f)

Declared at: libs/pika/command_line_handling/include/pika/command_line_handling/command_line_handling.hpp:25

Parameters

pika::util::runtime_configuration rtcfg

std::vector<std::string> ini_config

util::function<int( pika::program_options::variables_map&)> pika_main_f

void enable_logging_settings(
    pika::program_options::variables_map& vm,
    std::vector<std::string>& ini_config)

Description

////////////////////////////////////////////////////////////////////////

Declared at: libs/pika/command_line_handling/include/pika/command_line_handling/command_line_handling.hpp:79

Parameters

pika::program_options::variables_map& vm

std::vector<std::string>& ini_config

bool handle_arguments(
    util::manage_config& cfgmap,
    pika::program_options::variables_map& vm,
    std::vector<std::string>& ini_config)

Description

////////////////////////////////////////////////////////////////////////

Declared at: libs/pika/command_line_handling/include/pika/command_line_handling/command_line_handling.hpp:75

Parameters

util::manage_config& cfgmap

pika::program_options::variables_map& vm

std::vector<std::string>& ini_config

void handle_attach_debugger()

Declared at: libs/pika/command_line_handling/include/pika/command_line_handling/command_line_handling.hpp:88

bool handle_help_options(
    const pika::program_options::
        options_description& help)

Description

////////////////////////////////////////////////////////////////////////

Declared at: libs/pika/command_line_handling/include/pika/command_line_handling/command_line_handling.hpp:85

Parameters

const pika::program_options::options_description& help

std::vector<std::string>
preprocess_config_settings(int argc, char** argv)

Description

////////////////////////////////////////////////////////////////////////

Declared at: libs/pika/command_line_handling/include/pika/command_line_handling/command_line_handling.hpp:90

Parameters

int argc

char** argv

void store_command_line(int argc, char** argv)

Description

////////////////////////////////////////////////////////////////////////

Declared at: libs/pika/command_line_handling/include/pika/command_line_handling/command_line_handling.hpp:82

Parameters

int argc

char** argv

void store_unregistered_options(
    const std::string& cmd_name,
    const std::vector<std::string>&
        unregistered_options)

Description

////////////////////////////////////////////////////////////////////////

Declared at: libs/pika/command_line_handling/include/pika/command_line_handling/command_line_handling.hpp:83

Parameters

const std::string& cmd_name

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