IMP logo
IMP Reference Guide  develop.8b7eb21230,2024/06/24
The Integrative Modeling Platform
flags.h File Reference

Support for shared command line flags. More...

#include <IMP/kernel_config.h>
#include <boost/cstdint.hpp>
#include "types.h"
#include <string>
+ Include dependency graph for flags.h:
+ This graph shows which files directly or indirectly include this file:

Go to the source code of this file.


struct  IMP::AddBoolFlag
struct  IMP::AddFloatFlag
struct  IMP::AddIntFlag
struct  IMP::AddStringFlag


 Base functionality and abstract base classes for representation, scoring and sampling.


bool IMP::get_is_quick_test ()
void IMP::write_help (std::ostream &out=std::cerr)


These methods add support for shared command line flags to IMP. Programs that use this have access to flags declared in modules which allow users to do things like control log level and turn on and off profiling to see what is going on. These functions are Python accessible.

In C++, you can also use the AddFloatFlag, AddStringFlag, AddBoolFlag and AddIntFlag classes to add flags statically.

std::string IMP::get_executable_name ()
 Return the name of the current executable. More...
void IMP::setup_from_argv (int argc, char **argv, std::string description)
 Parse the command line flags and return the positional arguments. More...
Strings IMP::setup_from_argv_allowing_unknown (int argc, char **argv, std::string description)
Strings IMP::setup_from_argv (int argc, char **argv, std::string description, std::string positional_description, int num_positional)
void IMP::setup_from_argv (const Strings &argv, std::string description)
Strings IMP::setup_from_argv (const Strings &argv, std::string description, std::string positional_description, int num_positional)
void IMP::add_string_flag (std::string name, std::string default_value, std::string description)
std::string IMP::get_string_flag (std::string name)
void IMP::add_int_flag (std::string name, size_t default_value, std::string description)
size_t IMP::get_int_flag (std::string name)
void IMP::add_bool_flag (std::string name, std::string description)
bool IMP::get_bool_flag (std::string name)
void IMP::add_float_flag (std::string name, double default_value, std::string description)
double IMP::get_float_flag (std::string name)

Detailed Description

Support for shared command line flags.

Copyright 2007-2022 IMP Inventors. All rights reserved.

Definition in file flags.h.