hpx/runtime_configuration/component_commandline_base.hpp¶
See Public API for a list of names and headers that are part of the public HPX API.
Defines
-
HPX_REGISTER_COMMANDLINE_REGISTRY
(RegistryType, componentname)¶ The macro HPX_REGISTER_COMMANDLINE_REGISTRY is used to register the given component factory with Hpx.Plugin. This macro has to be used for each of the components.
-
HPX_REGISTER_COMMANDLINE_REGISTRY_DYNAMIC
(RegistryType, componentname)¶
-
HPX_REGISTER_COMMANDLINE_OPTIONS
()¶ The macro HPX_REGISTER_COMMANDLINE_OPTIONS is used to define the required Hpx.Plugin entry point for the command line option registry. This macro has to be used in not more than one compilation unit of a component module.
-
HPX_REGISTER_COMMANDLINE_OPTIONS_DYNAMIC
()¶
-
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
()¶
-
virtual hpx::program_options::options_description
add_commandline_options
() = 0¶ Return any additional command line options valid for this component.
- Return
The module is expected to fill a options_description object with any additional command line options this component will handle.
- Note
This function will be executed by the runtime system during system startup.
-
virtual
-
struct
-
namespace