helics  2.8.1
Public Types | Public Member Functions | Public Attributes | List of all members
helics::helicsCLI11App Class Reference
+ Inheritance diagram for helics::helicsCLI11App:

Public Types

enum  parse_output : int {
  ok = 0, help_call = 1, help_all_call = 2, version_call = 4,
  parse_error = -4
}
 

Public Member Functions

 helicsCLI11App (std::string app_description="", const std::string &app_name="")
 
template<typename... Args>
parse_output helics_parse (Args &&... args) noexcept
 
std::vector< std::string > & remainArgs ()
 
void remove_helics_specifics ()
 
void add_callback (std::function< void()> cback)
 
void addTypeOption (bool includeEnvironmentVariable=true)
 
core_type getCoreType () const
 
void setDefaultCoreType (core_type type)
 

Public Attributes

bool quiet {false}
 
bool passConfig {true}
 
parse_output last_output {parse_output::ok}
 

Member Function Documentation

◆ add_callback()

void helics::helicsCLI11App::add_callback ( std::function< void()>  cback)
inline

Add a callback function to execute on parsing

◆ setDefaultCoreType()

void helics::helicsCLI11App::setDefaultCoreType ( core_type  type)
inline

set default core type


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