YASK
Yet Another Stencil Kit: a software framework for creating HPC stencil code. Copyright 2014-2023 Intel Corporation.
Loading...
Searching...
No Matches
Public Member Functions | List of all members
yask::command_line_parser::idx_option Class Reference

An idx_t option. More...

#include <yask_common_api.hpp>

+ Inheritance diagram for yask::command_line_parser::idx_option:

Public Member Functions

 idx_option (const std::string &name, const std::string &help_msg, idx_t &val)
 Constructor.
 
virtual void print_help (std::ostream &os, int width) const override
 Print help message for an int_t option.
 
virtual std::ostream & print_value (std::ostream &os) const override
 Print the current value of the int_t.
 
virtual bool check_arg (const string_vec &args, int &argi) override
 Check for the option and its int_t argument.
 
- Public Member Functions inherited from yask::command_line_parser::option_base
 option_base (const std::string &name, const std::string &help_msg, const std::string &current_value_prefix=std::string("Current value = "), const std::string &help_line_prefix=std::string(" "))
 Constructor.
 
virtual const std::string & get_name () const
 Get the current option name.
 
virtual const std::string & get_help () const
 Get the unformatted help string.
 

Additional Inherited Members

- Protected Member Functions inherited from yask::command_line_parser::option_base
virtual void _print_help (std::ostream &os, const std::string &display_name, int width) const
 Format and print help for option named display_name to os.
 
virtual bool _is_opt (const string_vec &args, int &argi, const std::string &str) const
 Check for matching option to str at args[argi].
 
virtual double _double_val (const string_vec &args, int &argi)
 Get one double value from args[argi++].
 
virtual idx_t _idx_val (const string_vec &args, int &argi)
 Get one idx_t value from args[argi++].
 
virtual std::string _string_val (const string_vec &args, int &argi)
 Get one string value from args[argi++].
 

Detailed Description

An idx_t option.

Member Function Documentation

◆ print_help()

virtual void yask::command_line_parser::idx_option::print_help ( std::ostream &  os,
int  width 
) const
overridevirtual

Print help message for an int_t option.

Reimplemented from yask::command_line_parser::option_base.

◆ print_value()

virtual std::ostream & yask::command_line_parser::idx_option::print_value ( std::ostream &  os) const
inlineoverridevirtual

Print the current value of the int_t.

Implements yask::command_line_parser::option_base.

◆ check_arg()

virtual bool yask::command_line_parser::idx_option::check_arg ( const string_vec args,
int &  argi 
)
overridevirtual

Check for the option and its int_t argument.

Implements yask::command_line_parser::option_base.


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