Elements 6.0.1
A C++ base framework for the Euclid Software.
Loading...
Searching...
No Matches
Public Member Functions | List of all members
ExtProgramExample Class Reference
Inheritance diagram for ExtProgramExample:
Inheritance graph
[legend]
Collaboration diagram for ExtProgramExample:
Collaboration graph
[legend]

Public Member Functions

OptionsDescription defineSpecificProgramOptions () override
 Allows to define the (command line and configuration file) options specific to this program. More...
 
ExitCode mainMethod (map< string, VariableValue > &args) override
 The "main" method. More...
 
- Public Member Functions inherited from Elements::Program
 Program ()=default
 Constructor. More...
 
virtual ~Program ()
 Destructor. More...
 
virtual OptionsDescription defineSpecificProgramOptions ()
 This methods must be used to define specific program options. More...
 
virtual std::pair< OptionsDescription, PositionalOptionsDescriptiondefineProgramArguments ()
 This methods must be used to the program arguments. More...
 
virtual ExitCode mainMethod (std::map< std::string, VariableValue > &args)=0
 This is the "main" method of all Elements programs. More...
 

Additional Inherited Members

- Public Types inherited from Elements::Program
using options_description = boost::program_options::options_description
 
using positional_options_description = boost::program_options::positional_options_description
 
using variable_value = boost::program_options::variable_value
 
using variables_map = boost::program_options::variables_map
 
using OptionsDescription = options_description
 
using PositionalOptionsDescription = positional_options_description
 
using VariableValue = variable_value
 
using VariablesMap = variables_map
 
using ExitCode = Elements::ExitCode
 
using Logging = Elements::Logging
 

Detailed Description

Definition at line 57 of file ExtProgramExample.cpp.

Member Function Documentation

◆ defineSpecificProgramOptions()

OptionsDescription ExtProgramExample::defineSpecificProgramOptions ( )
inlineoverridevirtual

Allows to define the (command line and configuration file) options specific to this program.

See the ElementsProgram documentation for more details.

Returns
A BOOST program options_description

Reimplemented from Elements::Program.

Definition at line 69 of file ExtProgramExample.cpp.

◆ mainMethod()

ExitCode ExtProgramExample::mainMethod ( map< string, VariableValue > &  args)
inlineoverridevirtual

The "main" method.

This method is the entry point to the program. In this sense, it is similar to a main (and it is why it is called mainMethod()). The code below contains the calls to the different classes created for the first developer's workshop

See the ElementsProgram documentation for more details.

Implements Elements::Program.

Definition at line 106 of file ExtProgramExample.cpp.

References Elements::Examples::functionExample(), Elements::Logging::getLogger(), Elements::System::getThisExecutableInfo(), std::move(), Elements::Module::name(), Elements::Project::name(), Elements::System::ModuleInfo::name(), Elements::Examples::printProject(), Elements::Module::versionString(), and Elements::Project::versionString().

Here is the call graph for this function:

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