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

Public Types

enum class  ParseOutput : int {
  PARSE_ERROR = -4 , OK = 0 , HELP_CALL = 1 , HELP_ALL_CALL = 2 ,
  VERSION_CALL = 4 , SUCCESS_TERMINATION = 7
}
 

Public Member Functions

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

Public Attributes

bool quiet {false}
 
bool passConfig {true}
 
ParseOutput last_output {ParseOutput::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 ( CoreType  type)
inline

set default core type


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