hpx::components::component_commandline_base#

Defined in header hpx/components.hpp.

See Public API for a list of names and headers that are part of the public HPX API.

namespace hpx
namespace components#
struct component_commandline_base#
#include <component_commandline_base.hpp>

The component_commandline_base has to be used as a base class for all component command-line line handling registries.

Public Functions

virtual ~component_commandline_base() = default#
virtual hpx::program_options::options_description add_commandline_options() = 0#

Return any additional command line options valid for this component.

Note

This function will be executed by the runtime system during system startup.

Returns

The module is expected to fill a options_description object with any additional command line options this component will handle.